class Aws::SSOOIDC::Client

See {#initialize} for a full list of supported configuration options.
the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
For details on configuring region and credentials see
)
# …
credentials: credentials,
region: region_name,
client = Aws::SSOOIDC::Client.new(
An API client for SSOOIDC. To construct a client, you need to configure a ‘:region` and `:credentials`.

def build_request(operation_name, params = {})

Other tags:
    Api: - private

Parameters:
  • params ({}) -- 
def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-core'
  context[:gem_version] = '3.195.0'
  Seahorse::Client::Request.new(handlers, context)
end

def create_token(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • create_token(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/CreateToken - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -
    Example: Example: Call OAuth/OIDC /token endpoint for Refresh Token grant with Secret authentication -
    Example: Example: Call OAuth/OIDC /token endpoint for Device Code grant with Secret authentication -

Returns:
  • (Types::CreateTokenResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :code_verifier (String) --
  • :redirect_uri (String) --
  • :scope (Array) --
  • :refresh_token (String) --
  • :code (String) --
  • :device_code (String) --
  • :grant_type (required, String) --
  • :client_secret (required, String) --
  • :client_id (required, String) -- 
def create_token(params = {}, options = {})
  req = build_request(:create_token, params)
  req.send_request(options)
end

def create_token_with_iam(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • create_token_with_iam(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/CreateTokenWithIAM - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -
    Example: Example: Call OAuth/OIDC /token endpoint for Token Exchange grant with IAM authentication -
    Example: Example: Call OAuth/OIDC /token endpoint for JWT Bearer grant with IAM authentication -
    Example: Example: Call OAuth/OIDC /token endpoint for Refresh Token grant with IAM authentication -
    Example: Example: Call OAuth/OIDC /token endpoint for Authorization Code grant with IAM authentication -

Returns:
  • (Types::CreateTokenWithIAMResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :code_verifier (String) --
  • :requested_token_type (String) --
  • :subject_token_type (String) --
  • :subject_token (String) --
  • :redirect_uri (String) --
  • :scope (Array) --
  • :assertion (String) --
  • :refresh_token (String) --
  • :code (String) --
  • :grant_type (required, String) --
  • :client_id (required, String) -- 
def create_token_with_iam(params = {}, options = {})
  req = build_request(:create_token_with_iam, params)
  req.send_request(options)
end

def errors_module

Other tags:
    Api: - private 
def errors_module
  Errors
end

def initialize(*args)

Options Hash: (**options)
  • :ssl_verify_peer (Boolean) --
  • :ssl_timeout (Float) --
  • :ssl_ca_store (String) --
  • :ssl_ca_directory (String) --
  • :ssl_ca_bundle (String) --
  • :raise_response_errors (Boolean) --
  • :on_chunk_sent (Proc) --
  • :on_chunk_received (Proc) --
  • :http_wire_trace (Boolean) --
  • :http_read_timeout (Float) --
  • :http_proxy (URI::HTTP, String) --
  • :http_open_timeout (Float) --
  • :http_idle_timeout (Float) --
  • :http_continue_timeout (Float) --
  • :endpoint_provider (Aws::SSOOIDC::EndpointProvider) --
  • :validate_params (Boolean) --
  • :use_fips_endpoint (Boolean) --
  • :use_dualstack_endpoint (Boolean) --
  • :token_provider (Aws::TokenProvider) --
  • :stub_responses (Boolean) --
  • :session_token (String) --
  • :secret_access_key (String) --
  • :sdk_ua_app_id (String) --
  • :retry_mode (String) --
  • :retry_max_delay (Integer) --
  • :retry_limit (Integer) --
  • :retry_jitter (Symbol) --
  • :retry_base_delay (Float) --
  • :retry_backoff (Proc) --
  • :request_min_compression_size_bytes (Integer) --
  • :profile (String) --
  • :max_attempts (Integer) --
  • :logger (Logger) --
  • :log_level (Symbol) --
  • :log_formatter (Aws::Log::Formatter) --
  • :ignore_configured_endpoint_urls (Boolean) --
  • :endpoint_discovery (Boolean) --
  • :endpoint_cache_poll_interval (Integer) --
  • :endpoint_cache_max_threads (Integer) --
  • :endpoint_cache_max_entries (Integer) --
  • :endpoint (String, URI::HTTPS, URI::HTTP) --
  • :disable_request_compression (Boolean) --
  • :disable_host_prefix_injection (Boolean) --
  • :defaults_mode (String) --
  • :correct_clock_skew (Boolean) --
  • :convert_params (Boolean) --
  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) --
  • :client_side_monitoring_port (Integer) --
  • :client_side_monitoring_host (String) --
  • :client_side_monitoring_client_id (String) --
  • :client_side_monitoring (Boolean) --
  • :adaptive_retry_wait_to_fill (Boolean) --
  • :active_endpoint_cache (Boolean) --
  • :access_key_id (String) --
  • :region (required, String) --
  • :credentials (required, Aws::CredentialProvider) --

Other tags:
    See: https://www.awsarchitectureblog.com/2015/03/backoff.html -

Parameters:
  • options (Hash) --

Overloads:
  • initialize(options) 
def initialize(*args)
  super
end

def register_client(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • register_client(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/RegisterClient - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -
    Example: Example: Call OAuth/OIDC /register-client endpoint -

Returns:
  • (Types::RegisterClientResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :entitled_application_arn (String) --
  • :issuer_url (String) --
  • :grant_types (Array) --
  • :redirect_uris (Array) --
  • :scopes (Array) --
  • :client_type (required, String) --
  • :client_name (required, String) -- 
def register_client(params = {}, options = {})
  req = build_request(:register_client, params)
  req.send_request(options)
end

def start_device_authorization(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • start_device_authorization(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/StartDeviceAuthorization - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -
    Example: Example: Call OAuth/OIDC /start-device-authorization endpoint -

Returns:
  • (Types::StartDeviceAuthorizationResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :start_url (required, String) --
  • :client_secret (required, String) --
  • :client_id (required, String) -- 
def start_device_authorization(params = {}, options = {})
  req = build_request(:start_device_authorization, params)
  req.send_request(options)
end

def waiter_names

Deprecated:

Other tags:
    Api: - private 
def waiter_names
  []
end