# frozen_string_literal: true # WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE require 'seahorse/client/plugins/content_length.rb' require 'aws-sdk-core/plugins/credentials_configuration.rb' require 'aws-sdk-core/plugins/logging.rb' require 'aws-sdk-core/plugins/param_converter.rb' require 'aws-sdk-core/plugins/param_validator.rb' require 'aws-sdk-core/plugins/user_agent.rb' require 'aws-sdk-core/plugins/helpful_socket_errors.rb' require 'aws-sdk-core/plugins/retry_errors.rb' require 'aws-sdk-core/plugins/global_configuration.rb' require 'aws-sdk-core/plugins/regional_endpoint.rb' require 'aws-sdk-core/plugins/endpoint_discovery.rb' require 'aws-sdk-core/plugins/endpoint_pattern.rb' require 'aws-sdk-core/plugins/response_paging.rb' require 'aws-sdk-core/plugins/stub_responses.rb' require 'aws-sdk-core/plugins/idempotency_token.rb' require 'aws-sdk-core/plugins/invocation_id.rb' require 'aws-sdk-core/plugins/jsonvalue_converter.rb' require 'aws-sdk-core/plugins/client_metrics_plugin.rb' require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb' require 'aws-sdk-core/plugins/transfer_encoding.rb' require 'aws-sdk-core/plugins/http_checksum.rb' require 'aws-sdk-core/plugins/checksum_algorithm.rb' require 'aws-sdk-core/plugins/request_compression.rb' require 'aws-sdk-core/plugins/defaults_mode.rb' require 'aws-sdk-core/plugins/recursion_detection.rb' require 'aws-sdk-core/plugins/telemetry.rb' require 'aws-sdk-core/plugins/sign.rb' require 'aws-sdk-core/plugins/protocols/rest_json.rb' Aws::Plugins::GlobalConfiguration.add_identifier(:ssooidc) module Aws::SSOOIDC # An API client for SSOOIDC. To construct a client, you need to configure a `:region` and `:credentials`. # # client = Aws::SSOOIDC::Client.new( # region: region_name, # credentials: credentials, # # ... # ) # # For details on configuring region and credentials see # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html). # # See {#initialize} for a full list of supported configuration options. class Client < Seahorse::Client::Base include Aws::ClientStubs @identifier = :ssooidc set_api(ClientApi::API) add_plugin(Seahorse::Client::Plugins::ContentLength) add_plugin(Aws::Plugins::CredentialsConfiguration) add_plugin(Aws::Plugins::Logging) add_plugin(Aws::Plugins::ParamConverter) add_plugin(Aws::Plugins::ParamValidator) add_plugin(Aws::Plugins::UserAgent) add_plugin(Aws::Plugins::HelpfulSocketErrors) add_plugin(Aws::Plugins::RetryErrors) add_plugin(Aws::Plugins::GlobalConfiguration) add_plugin(Aws::Plugins::RegionalEndpoint) add_plugin(Aws::Plugins::EndpointDiscovery) add_plugin(Aws::Plugins::EndpointPattern) add_plugin(Aws::Plugins::ResponsePaging) add_plugin(Aws::Plugins::StubResponses) add_plugin(Aws::Plugins::IdempotencyToken) add_plugin(Aws::Plugins::InvocationId) add_plugin(Aws::Plugins::JsonvalueConverter) add_plugin(Aws::Plugins::ClientMetricsPlugin) add_plugin(Aws::Plugins::ClientMetricsSendPlugin) add_plugin(Aws::Plugins::TransferEncoding) add_plugin(Aws::Plugins::HttpChecksum) add_plugin(Aws::Plugins::ChecksumAlgorithm) add_plugin(Aws::Plugins::RequestCompression) add_plugin(Aws::Plugins::DefaultsMode) add_plugin(Aws::Plugins::RecursionDetection) add_plugin(Aws::Plugins::Telemetry) add_plugin(Aws::Plugins::Sign) add_plugin(Aws::Plugins::Protocols::RestJson) add_plugin(Aws::SSOOIDC::Plugins::Endpoints) # @overload initialize(options) # @param [Hash] options # # @option options [Array] :plugins ([]]) # A list of plugins to apply to the client. Each plugin is either a # class name or an instance of a plugin class. # # @option options [required, Aws::CredentialProvider] :credentials # Your AWS credentials. This can be an instance of any one of the # following classes: # # * `Aws::Credentials` - Used for configuring static, non-refreshing # credentials. # # * `Aws::SharedCredentials` - Used for loading static credentials from a # shared file, such as `~/.aws/config`. # # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role. # # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to # assume a role after providing credentials via the web. # # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an # access token generated from `aws login`. # # * `Aws::ProcessCredentials` - Used for loading credentials from a # process that outputs to stdout. # # * `Aws::InstanceProfileCredentials` - Used for loading credentials # from an EC2 IMDS on an EC2 instance. # # * `Aws::ECSCredentials` - Used for loading credentials from # instances running in ECS. # # * `Aws::CognitoIdentityCredentials` - Used for loading credentials # from the Cognito Identity service. # # When `:credentials` are not configured directly, the following # locations will be searched for credentials: # # * `Aws.config[:credentials]` # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options. # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'] # * `~/.aws/credentials` # * `~/.aws/config` # * EC2/ECS IMDS instance profile - When used by default, the timeouts # are very aggressive. Construct and pass an instance of # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to # enable retries and extended timeouts. Instance profile credential # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] # to true. # # @option options [required, String] :region # The AWS region to connect to. The configured `:region` is # used to determine the service `:endpoint`. When not passed, # a default `:region` is searched for in the following locations: # # * `Aws.config[:region]` # * `ENV['AWS_REGION']` # * `ENV['AMAZON_REGION']` # * `ENV['AWS_DEFAULT_REGION']` # * `~/.aws/credentials` # * `~/.aws/config` # # @option options [String] :access_key_id # # @option options [Boolean] :active_endpoint_cache (false) # When set to `true`, a thread polling for endpoints will be running in # the background every 60 secs (default). Defaults to `false`. # # @option options [Boolean] :adaptive_retry_wait_to_fill (true) # Used only in `adaptive` retry mode. When true, the request will sleep # until there is sufficent client side capacity to retry the request. # When false, the request will raise a `RetryCapacityNotAvailableError` and will # not retry instead of sleeping. # # @option options [Boolean] :client_side_monitoring (false) # When `true`, client-side metrics will be collected for all API requests from # this client. # # @option options [String] :client_side_monitoring_client_id ("") # Allows you to provide an identifier for this client which will be attached to # all generated client side metrics. Defaults to an empty string. # # @option options [String] :client_side_monitoring_host ("127.0.0.1") # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client # side monitoring agent is running on, where client metrics will be published via UDP. # # @option options [Integer] :client_side_monitoring_port (31000) # Required for publishing client metrics. The port that the client side monitoring # agent is running on, where client metrics will be published via UDP. # # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) # Allows you to provide a custom client-side monitoring publisher class. By default, # will use the Client Side Monitoring Agent Publisher. # # @option options [Boolean] :convert_params (true) # When `true`, an attempt is made to coerce request parameters into # the required types. # # @option options [Boolean] :correct_clock_skew (true) # Used only in `standard` and adaptive retry modes. Specifies whether to apply # a clock skew correction and retry requests with skewed client clocks. # # @option options [String] :defaults_mode ("legacy") # See {Aws::DefaultsModeConfiguration} for a list of the # accepted modes and the configuration defaults that are included. # # @option options [Boolean] :disable_host_prefix_injection (false) # Set to true to disable SDK automatically adding host prefix # to default service endpoint when available. # # @option options [Boolean] :disable_request_compression (false) # When set to 'true' the request body will not be compressed # for supported operations. # # @option options [String, URI::HTTPS, URI::HTTP] :endpoint # Normally you should not configure the `:endpoint` option # directly. This is normally constructed from the `:region` # option. Configuring `:endpoint` is normally reserved for # connecting to test or custom endpoints. The endpoint should # be a URI formatted like: # # 'http://example.com' # 'https://example.com' # 'http://example.com:123' # # @option options [Integer] :endpoint_cache_max_entries (1000) # Used for the maximum size limit of the LRU cache storing endpoints data # for endpoint discovery enabled operations. Defaults to 1000. # # @option options [Integer] :endpoint_cache_max_threads (10) # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. # # @option options [Integer] :endpoint_cache_poll_interval (60) # When :endpoint_discovery and :active_endpoint_cache is enabled, # Use this option to config the time interval in seconds for making # requests fetching endpoints information. Defaults to 60 sec. # # @option options [Boolean] :endpoint_discovery (false) # When set to `true`, endpoint discovery will be enabled for operations when available. # # @option options [Boolean] :ignore_configured_endpoint_urls # Setting to true disables use of endpoint URLs provided via environment # variables and the shared configuration file. # # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) # The log formatter. # # @option options [Symbol] :log_level (:info) # The log level to send messages to the `:logger` at. # # @option options [Logger] :logger # The Logger instance to send log messages to. If this option # is not set, logging will be disabled. # # @option options [Integer] :max_attempts (3) # An integer representing the maximum number attempts that will be made for # a single request, including the initial attempt. For example, # setting this value to 5 will result in a request being retried up to # 4 times. Used in `standard` and `adaptive` retry modes. # # @option options [String] :profile ("default") # Used when loading credentials from the shared credentials file # at HOME/.aws/credentials. When not specified, 'default' is used. # # @option options [Integer] :request_min_compression_size_bytes (10240) # The minimum size in bytes that triggers compression for request # bodies. The value must be non-negative integer value between 0 # and 10485780 bytes inclusive. # # @option options [Proc] :retry_backoff # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. # This option is only used in the `legacy` retry mode. # # @option options [Float] :retry_base_delay (0.3) # The base delay in seconds used by the default backoff function. This option # is only used in the `legacy` retry mode. # # @option options [Symbol] :retry_jitter (:none) # A delay randomiser function used by the default backoff function. # Some predefined functions can be referenced by name - :none, :equal, :full, # otherwise a Proc that takes and returns a number. This option is only used # in the `legacy` retry mode. # # @see https://www.awsarchitectureblog.com/2015/03/backoff.html # # @option options [Integer] :retry_limit (3) # The maximum number of times to retry failed requests. Only # ~ 500 level server errors and certain ~ 400 level client errors # are retried. Generally, these are throttling errors, data # checksum errors, networking errors, timeout errors, auth errors, # endpoint discovery, and errors from expired credentials. # This option is only used in the `legacy` retry mode. # # @option options [Integer] :retry_max_delay (0) # The maximum number of seconds to delay between retries (0 for no limit) # used by the default backoff function. This option is only used in the # `legacy` retry mode. # # @option options [String] :retry_mode ("legacy") # Specifies which retry algorithm to use. Values are: # # * `legacy` - The pre-existing retry behavior. This is default value if # no retry mode is provided. # # * `standard` - A standardized set of retry rules across the AWS SDKs. # This includes support for retry quotas, which limit the number of # unsuccessful retries a client can make. # # * `adaptive` - An experimental retry mode that includes all the # functionality of `standard` mode along with automatic client side # throttling. This is a provisional mode that may change behavior # in the future. # # @option options [String] :sdk_ua_app_id # A unique and opaque application ID that is appended to the # User-Agent header as app/sdk_ua_app_id. It should have a # maximum length of 50. This variable is sourced from environment # variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id. # # @option options [String] :secret_access_key # # @option options [String] :session_token # # @option options [Array] :sigv4a_signing_region_set # A list of regions that should be signed with SigV4a signing. When # not passed, a default `:sigv4a_signing_region_set` is searched for # in the following locations: # # * `Aws.config[:sigv4a_signing_region_set]` # * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']` # * `~/.aws/config` # # @option options [Boolean] :stub_responses (false) # Causes the client to return stubbed responses. By default # fake responses are generated and returned. You can specify # the response data to return or errors to raise by calling # {ClientStubs#stub_responses}. See {ClientStubs} for more information. # # ** Please note ** When response stubbing is enabled, no HTTP # requests are made, and retries are disabled. # # @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider) # Allows you to provide a telemetry provider, which is used to # emit telemetry data. By default, uses `NoOpTelemetryProvider` which # will not record or emit any telemetry data. The SDK supports the # following telemetry providers: # # * OpenTelemetry (OTel) - To use the OTel provider, install and require the # `opentelemetry-sdk` gem and then, pass in an instance of a # `Aws::Telemetry::OTelProvider` for telemetry provider. # # @option options [Aws::TokenProvider] :token_provider # A Bearer Token Provider. This can be an instance of any one of the # following classes: # # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing # tokens. # # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an # access token generated from `aws login`. # # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain` # will be used to search for tokens configured for your profile in shared configuration files. # # @option options [Boolean] :use_dualstack_endpoint # When set to `true`, dualstack enabled endpoints (with `.aws` TLD) # will be used if available. # # @option options [Boolean] :use_fips_endpoint # When set to `true`, fips compatible endpoints will be used if available. # When a `fips` region is used, the region is normalized and this config # is set to `true`. # # @option options [Boolean] :validate_params (true) # When `true`, request parameters are validated before # sending the request. # # @option options [Aws::SSOOIDC::EndpointProvider] :endpoint_provider # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::SSOOIDC::EndpointParameters` # # @option options [Float] :http_continue_timeout (1) # The number of seconds to wait for a 100-continue response before sending the # request body. This option has no effect unless the request has "Expect" # header set to "100-continue". Defaults to `nil` which disables this # behaviour. This value can safely be set per request on the session. # # @option options [Float] :http_idle_timeout (5) # The number of seconds a connection is allowed to sit idle before it # is considered stale. Stale connections are closed and removed from the # pool before making a request. # # @option options [Float] :http_open_timeout (15) # The default number of seconds to wait for response data. # This value can safely be set per-request on the session. # # @option options [URI::HTTP,String] :http_proxy # A proxy to send requests through. Formatted like 'http://proxy.com:123'. # # @option options [Float] :http_read_timeout (60) # The default number of seconds to wait for response data. # This value can safely be set per-request on the session. # # @option options [Boolean] :http_wire_trace (false) # When `true`, HTTP debug output will be sent to the `:logger`. # # @option options [Proc] :on_chunk_received # When a Proc object is provided, it will be used as callback when each chunk # of the response body is received. It provides three arguments: the chunk, # the number of bytes received, and the total number of # bytes in the response (or nil if the server did not send a `content-length`). # # @option options [Proc] :on_chunk_sent # When a Proc object is provided, it will be used as callback when each chunk # of the request body is sent. It provides three arguments: the chunk, # the number of bytes read from the body, and the total number of # bytes in the body. # # @option options [Boolean] :raise_response_errors (true) # When `true`, response errors are raised. # # @option options [String] :ssl_ca_bundle # Full path to the SSL certificate authority bundle file that should be used when # verifying peer certificates. If you do not pass `:ssl_ca_bundle` or # `:ssl_ca_directory` the the system default will be used if available. # # @option options [String] :ssl_ca_directory # Full path of the directory that contains the unbundled SSL certificate # authority files for verifying peer certificates. If you do # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system # default will be used if available. # # @option options [String] :ssl_ca_store # Sets the X509::Store to verify peer certificate. # # @option options [OpenSSL::X509::Certificate] :ssl_cert # Sets a client certificate when creating http connections. # # @option options [OpenSSL::PKey] :ssl_key # Sets a client key when creating http connections. # # @option options [Float] :ssl_timeout # Sets the SSL timeout in seconds # # @option options [Boolean] :ssl_verify_peer (true) # When `true`, SSL peer certificates are verified when establishing a connection. # def initialize(*args) super end # @!group API Operations # Creates and returns access and refresh tokens for clients that are # authenticated using client secrets. The access token can be used to # fetch short-term credentials for the assigned AWS accounts or to # access application APIs using `bearer` authentication. # # @option params [required, String] :client_id # The unique identifier string for the client or application. This value # comes from the result of the RegisterClient API. # # @option params [required, String] :client_secret # A secret string generated for the client. This value should come from # the persisted result of the RegisterClient API. # # @option params [required, String] :grant_type # Supports the following OAuth grant types: Device Code and Refresh # Token. Specify either of the following values, depending on the grant # type that you want: # # * Device Code - `urn:ietf:params:oauth:grant-type:device_code` # # * Refresh Token - `refresh_token` # # For information about how to obtain the device code, see the # StartDeviceAuthorization topic. # # @option params [String] :device_code # Used only when calling this API for the Device Code grant type. This # short-term code is used to identify this authorization request. This # comes from the result of the StartDeviceAuthorization API. # # @option params [String] :code # Used only when calling this API for the Authorization Code grant type. # The short-term code is used to identify this authorization request. # This grant type is currently unsupported for the CreateToken API. # # @option params [String] :refresh_token # Used only when calling this API for the Refresh Token grant type. This # token is used to refresh short-term tokens, such as the access token, # that might expire. # # For more information about the features and limitations of the current # IAM Identity Center OIDC implementation, see *Considerations for Using # this Guide* in the [IAM Identity Center OIDC API Reference][1]. # # # # [1]: https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html # # @option params [Array] :scope # The list of scopes for which authorization is requested. The access # token that is issued is limited to the scopes that are granted. If # this value is not specified, IAM Identity Center authorizes all scopes # that are configured for the client during the call to RegisterClient. # # @option params [String] :redirect_uri # Used only when calling this API for the Authorization Code grant type. # This value specifies the location of the client or application that # has registered to receive the authorization code. # # @option params [String] :code_verifier # Used only when calling this API for the Authorization Code grant type. # This value is generated by the client and presented to validate the # original code challenge value the client passed at authorization time. # # @return [Types::CreateTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateTokenResponse#access_token #access_token} => String # * {Types::CreateTokenResponse#token_type #token_type} => String # * {Types::CreateTokenResponse#expires_in #expires_in} => Integer # * {Types::CreateTokenResponse#refresh_token #refresh_token} => String # * {Types::CreateTokenResponse#id_token #id_token} => String # # # @example Example: Call OAuth/OIDC /token endpoint for Device Code grant with Secret authentication # # resp = client.create_token({ # client_id: "_yzkThXVzLWVhc3QtMQEXAMPLECLIENTID", # client_secret: "VERYLONGSECRETeyJraWQiOiJrZXktMTU2NDAyODA5OSIsImFsZyI6IkhTMzg0In0", # device_code: "yJraWQiOiJrZXktMTU2Njk2ODA4OCIsImFsZyI6IkhTMzIn0EXAMPLEDEVICECODE", # grant_type: "urn:ietf:params:oauth:grant-type:device-code", # }) # # resp.to_h outputs the following: # { # access_token: "aoal-YigITUDiNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZidEXAMPLEACCESSTOKEN", # expires_in: 1579729529, # refresh_token: "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN", # token_type: "Bearer", # } # # @example Example: Call OAuth/OIDC /token endpoint for Refresh Token grant with Secret authentication # # resp = client.create_token({ # client_id: "_yzkThXVzLWVhc3QtMQEXAMPLECLIENTID", # client_secret: "VERYLONGSECRETeyJraWQiOiJrZXktMTU2NDAyODA5OSIsImFsZyI6IkhTMzg0In0", # grant_type: "refresh_token", # refresh_token: "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN", # scope: [ # "codewhisperer:completions", # ], # }) # # resp.to_h outputs the following: # { # access_token: "aoal-YigITUDiNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZidEXAMPLEACCESSTOKEN", # expires_in: 1579729529, # refresh_token: "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN", # token_type: "Bearer", # } # # @example Request syntax with placeholder values # # resp = client.create_token({ # client_id: "ClientId", # required # client_secret: "ClientSecret", # required # grant_type: "GrantType", # required # device_code: "DeviceCode", # code: "AuthCode", # refresh_token: "RefreshToken", # scope: ["Scope"], # redirect_uri: "URI", # code_verifier: "CodeVerifier", # }) # # @example Response structure # # resp.access_token #=> String # resp.token_type #=> String # resp.expires_in #=> Integer # resp.refresh_token #=> String # resp.id_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/CreateToken AWS API Documentation # # @overload create_token(params = {}) # @param [Hash] params ({}) def create_token(params = {}, options = {}) req = build_request(:create_token, params) req.send_request(options) end # Creates and returns access and refresh tokens for clients and # applications that are authenticated using IAM entities. The access # token can be used to fetch short-term credentials for the assigned # Amazon Web Services accounts or to access application APIs using # `bearer` authentication. # # @option params [required, String] :client_id # The unique identifier string for the client or application. This value # is an application ARN that has OAuth grants configured. # # @option params [required, String] :grant_type # Supports the following OAuth grant types: Authorization Code, Refresh # Token, JWT Bearer, and Token Exchange. Specify one of the following # values, depending on the grant type that you want: # # * Authorization Code - `authorization_code` # # * Refresh Token - `refresh_token` # # * JWT Bearer - `urn:ietf:params:oauth:grant-type:jwt-bearer` # # * Token Exchange - `urn:ietf:params:oauth:grant-type:token-exchange` # # @option params [String] :code # Used only when calling this API for the Authorization Code grant type. # This short-term code is used to identify this authorization request. # The code is obtained through a redirect from IAM Identity Center to a # redirect URI persisted in the Authorization Code GrantOptions for the # application. # # @option params [String] :refresh_token # Used only when calling this API for the Refresh Token grant type. This # token is used to refresh short-term tokens, such as the access token, # that might expire. # # For more information about the features and limitations of the current # IAM Identity Center OIDC implementation, see *Considerations for Using # this Guide* in the [IAM Identity Center OIDC API Reference][1]. # # # # [1]: https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html # # @option params [String] :assertion # Used only when calling this API for the JWT Bearer grant type. This # value specifies the JSON Web Token (JWT) issued by a trusted token # issuer. To authorize a trusted token issuer, configure the JWT Bearer # GrantOptions for the application. # # @option params [Array] :scope # The list of scopes for which authorization is requested. The access # token that is issued is limited to the scopes that are granted. If the # value is not specified, IAM Identity Center authorizes all scopes # configured for the application, including the following default # scopes: `openid`, `aws`, `sts:identity_context`. # # @option params [String] :redirect_uri # Used only when calling this API for the Authorization Code grant type. # This value specifies the location of the client or application that # has registered to receive the authorization code. # # @option params [String] :subject_token # Used only when calling this API for the Token Exchange grant type. # This value specifies the subject of the exchange. The value of the # subject token must be an access token issued by IAM Identity Center to # a different client or application. The access token must have # authorized scopes that indicate the requested application as a target # audience. # # @option params [String] :subject_token_type # Used only when calling this API for the Token Exchange grant type. # This value specifies the type of token that is passed as the subject # of the exchange. The following value is supported: # # * Access Token - `urn:ietf:params:oauth:token-type:access_token` # # @option params [String] :requested_token_type # Used only when calling this API for the Token Exchange grant type. # This value specifies the type of token that the requester can receive. # The following values are supported: # # * Access Token - `urn:ietf:params:oauth:token-type:access_token` # # * Refresh Token - `urn:ietf:params:oauth:token-type:refresh_token` # # @option params [String] :code_verifier # Used only when calling this API for the Authorization Code grant type. # This value is generated by the client and presented to validate the # original code challenge value the client passed at authorization time. # # @return [Types::CreateTokenWithIAMResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateTokenWithIAMResponse#access_token #access_token} => String # * {Types::CreateTokenWithIAMResponse#token_type #token_type} => String # * {Types::CreateTokenWithIAMResponse#expires_in #expires_in} => Integer # * {Types::CreateTokenWithIAMResponse#refresh_token #refresh_token} => String # * {Types::CreateTokenWithIAMResponse#id_token #id_token} => String # * {Types::CreateTokenWithIAMResponse#issued_token_type #issued_token_type} => String # * {Types::CreateTokenWithIAMResponse#scope #scope} => Array<String> # # # @example Example: Call OAuth/OIDC /token endpoint for Authorization Code grant with IAM authentication # # resp = client.create_token_with_iam({ # client_id: "arn:aws:sso::123456789012:application/ssoins-111111111111/apl-222222222222", # code: "yJraWQiOiJrZXktMTU2Njk2ODA4OCIsImFsZyI6IkhTMzg0In0EXAMPLEAUTHCODE", # grant_type: "authorization_code", # redirect_uri: "https://mywebapp.example/redirect", # scope: [ # "openid", # "aws", # "sts:identity_context", # ], # }) # # resp.to_h outputs the following: # { # access_token: "aoal-YigITUDiNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZidEXAMPLEACCESSTOKEN", # expires_in: 1579729529, # id_token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhd3M6aWRlbnRpdHlfc3RvcmVfaWQiOiJkLTMzMzMzMzMzMzMiLCJzdWIiOiI3MzA0NDhmMi1lMGExLTcwYTctYzk1NC0wMDAwMDAwMDAwMDAiLCJhd3M6aW5zdGFuY2VfYWNjb3VudCI6IjExMTExMTExMTExMSIsInN0czppZGVudGl0eV9jb250ZXh0IjoiRVhBTVBMRUlERU5USVRZQ09OVEVYVCIsInN0czphdWRpdF9jb250ZXh0IjoiRVhBTVBMRUFVRElUQ09OVEVYVCIsImlzcyI6Imh0dHBzOi8vaWRlbnRpdHljZW50ZXIuYW1hem9uYXdzLmNvbS9zc29pbnMtMTExMTExMTExMTExIiwiYXdzOmlkZW50aXR5X3N0b3JlX2FybiI6ImFybjphd3M6aWRlbnRpdHlzdG9yZTo6MTExMTExMTExMTExOmlkZW50aXR5c3RvcmUvZC0zMzMzMzMzMzMzIiwiYXVkIjoiYXJuOmF3czpzc286OjEyMzQ1Njc4OTAxMjphcHBsaWNhdGlvbi9zc29pbnMtMTExMTExMTExMTExL2FwbC0yMjIyMjIyMjIyMjIiLCJhd3M6aW5zdGFuY2VfYXJuIjoiYXJuOmF3czpzc286OjppbnN0YW5jZS9zc29pbnMtMTExMTExMTExMTExIiwiYXdzOmNyZWRlbnRpYWxfaWQiOiJfWlIyTjZhVkJqMjdGUEtheWpfcEtwVjc3QVBERl80MXB4ZXRfWWpJdUpONlVJR2RBdkpFWEFNUExFQ1JFRElEIiwiYXV0aF90aW1lIjoiMjAyMC0wMS0yMlQxMjo0NToyOVoiLCJleHAiOjE1Nzk3Mjk1MjksImlhdCI6MTU3OTcyNTkyOX0.Xyah6qbk78qThzJ41iFU2yfGuRqqtKXHrJYwQ8L9Ip0", # issued_token_type: "urn:ietf:params:oauth:token-type:refresh_token", # refresh_token: "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN", # scope: [ # "openid", # "aws", # "sts:identity_context", # ], # token_type: "Bearer", # } # # @example Example: Call OAuth/OIDC /token endpoint for Refresh Token grant with IAM authentication # # resp = client.create_token_with_iam({ # client_id: "arn:aws:sso::123456789012:application/ssoins-111111111111/apl-222222222222", # grant_type: "refresh_token", # refresh_token: "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN", # }) # # resp.to_h outputs the following: # { # access_token: "aoal-YigITUDiNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZidEXAMPLEACCESSTOKEN", # expires_in: 1579729529, # issued_token_type: "urn:ietf:params:oauth:token-type:refresh_token", # refresh_token: "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN", # scope: [ # "openid", # "aws", # "sts:identity_context", # ], # token_type: "Bearer", # } # # @example Example: Call OAuth/OIDC /token endpoint for JWT Bearer grant with IAM authentication # # resp = client.create_token_with_iam({ # assertion: "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6IjFMVE16YWtpaGlSbGFfOHoyQkVKVlhlV01xbyJ9.eyJ2ZXIiOiIyLjAiLCJpc3MiOiJodHRwczovL2xvZ2luLm1pY3Jvc29mdG9ubGluZS5jb20vOTEyMjA0MGQtNmM2Ny00YzViLWIxMTItMzZhMzA0YjY2ZGFkL3YyLjAiLCJzdWIiOiJBQUFBQUFBQUFBQUFBQUFBQUFBQUFJa3pxRlZyU2FTYUZIeTc4MmJidGFRIiwiYXVkIjoiNmNiMDQwMTgtYTNmNS00NmE3LWI5OTUtOTQwYzc4ZjVhZWYzIiwiZXhwIjoxNTM2MzYxNDExLCJpYXQiOjE1MzYyNzQ3MTEsIm5iZiI6MTUzNjI3NDcxMSwibmFtZSI6IkFiZSBMaW5jb2xuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoiQWJlTGlAbWljcm9zb2Z0LmNvbSIsIm9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC02NmYzLTMzMzJlY2E3ZWE4MSIsInRpZCI6IjkxMjIwNDBkLTZjNjctNGM1Yi1iMTEyLTM2YTMwNGI2NmRhZCIsIm5vbmNlIjoiMTIzNTIzIiwiYWlvIjoiRGYyVVZYTDFpeCFsTUNXTVNPSkJjRmF0emNHZnZGR2hqS3Y4cTVnMHg3MzJkUjVNQjVCaXN2R1FPN1lXQnlqZDhpUURMcSFlR2JJRGFreXA1bW5PcmNkcUhlWVNubHRlcFFtUnA2QUlaOGpZIn0.1AFWW-Ck5nROwSlltm7GzZvDwUkqvhSQpm55TQsmVo9Y59cLhRXpvB8n-55HCr9Z6G_31_UbeUkoz612I2j_Sm9FFShSDDjoaLQr54CreGIJvjtmS3EkK9a7SJBbcpL1MpUtlfygow39tFjY7EVNW9plWUvRrTgVk7lYLprvfzw-CIqw3gHC-T7IK_m_xkr08INERBtaecwhTeN4chPC4W3jdmw_lIxzC48YoQ0dB1L9-ImX98Egypfrlbm0IBL5spFzL6JDZIRRJOu8vecJvj1mq-IUhGt0MacxX8jdxYLP-KUu2d9MbNKpCKJuZ7p8gwTL5B7NlUdh_dmSviPWrw", # client_id: "arn:aws:sso::123456789012:application/ssoins-111111111111/apl-222222222222", # grant_type: "urn:ietf:params:oauth:grant-type:jwt-bearer", # }) # # resp.to_h outputs the following: # { # access_token: "aoal-YigITUDiNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZidEXAMPLEACCESSTOKEN", # expires_in: 1579729529, # id_token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhd3M6aWRlbnRpdHlfc3RvcmVfaWQiOiJkLTMzMzMzMzMzMzMiLCJzdWIiOiI3MzA0NDhmMi1lMGExLTcwYTctYzk1NC0wMDAwMDAwMDAwMDAiLCJhd3M6aW5zdGFuY2VfYWNjb3VudCI6IjExMTExMTExMTExMSIsInN0czppZGVudGl0eV9jb250ZXh0IjoiRVhBTVBMRUlERU5USVRZQ09OVEVYVCIsInN0czphdWRpdF9jb250ZXh0IjoiRVhBTVBMRUFVRElUQ09OVEVYVCIsImlzcyI6Imh0dHBzOi8vaWRlbnRpdHljZW50ZXIuYW1hem9uYXdzLmNvbS9zc29pbnMtMTExMTExMTExMTExIiwiYXdzOmlkZW50aXR5X3N0b3JlX2FybiI6ImFybjphd3M6aWRlbnRpdHlzdG9yZTo6MTExMTExMTExMTExOmlkZW50aXR5c3RvcmUvZC0zMzMzMzMzMzMzIiwiYXVkIjoiYXJuOmF3czpzc286OjEyMzQ1Njc4OTAxMjphcHBsaWNhdGlvbi9zc29pbnMtMTExMTExMTExMTExL2FwbC0yMjIyMjIyMjIyMjIiLCJhd3M6aW5zdGFuY2VfYXJuIjoiYXJuOmF3czpzc286OjppbnN0YW5jZS9zc29pbnMtMTExMTExMTExMTExIiwiYXdzOmNyZWRlbnRpYWxfaWQiOiJfWlIyTjZhVkJqMjdGUEtheWpfcEtwVjc3QVBERl80MXB4ZXRfWWpJdUpONlVJR2RBdkpFWEFNUExFQ1JFRElEIiwiYXV0aF90aW1lIjoiMjAyMC0wMS0yMlQxMjo0NToyOVoiLCJleHAiOjE1Nzk3Mjk1MjksImlhdCI6MTU3OTcyNTkyOX0.Xyah6qbk78qThzJ41iFU2yfGuRqqtKXHrJYwQ8L9Ip0", # issued_token_type: "urn:ietf:params:oauth:token-type:refresh_token", # refresh_token: "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN", # scope: [ # "openid", # "aws", # "sts:identity_context", # ], # token_type: "Bearer", # } # # @example Example: Call OAuth/OIDC /token endpoint for Token Exchange grant with IAM authentication # # resp = client.create_token_with_iam({ # client_id: "arn:aws:sso::123456789012:application/ssoins-111111111111/apl-222222222222", # grant_type: "urn:ietf:params:oauth:grant-type:token-exchange", # requested_token_type: "urn:ietf:params:oauth:token-type:access_token", # subject_token: "aoak-Hig8TUDPNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZDIFFERENTACCESSTOKEN", # subject_token_type: "urn:ietf:params:oauth:token-type:access_token", # }) # # resp.to_h outputs the following: # { # access_token: "aoal-YigITUDiNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZidEXAMPLEACCESSTOKEN", # expires_in: 1579729529, # id_token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhd3M6aWRlbnRpdHlfc3RvcmVfaWQiOiJkLTMzMzMzMzMzMzMiLCJzdWIiOiI3MzA0NDhmMi1lMGExLTcwYTctYzk1NC0wMDAwMDAwMDAwMDAiLCJhd3M6aW5zdGFuY2VfYWNjb3VudCI6IjExMTExMTExMTExMSIsInN0czppZGVudGl0eV9jb250ZXh0IjoiRVhBTVBMRUlERU5USVRZQ09OVEVYVCIsImlzcyI6Imh0dHBzOi8vaWRlbnRpdHljZW50ZXIuYW1hem9uYXdzLmNvbS9zc29pbnMtMTExMTExMTExMTExIiwiYXdzOmlkZW50aXR5X3N0b3JlX2FybiI6ImFybjphd3M6aWRlbnRpdHlzdG9yZTo6MTExMTExMTExMTExOmlkZW50aXR5c3RvcmUvZC0zMzMzMzMzMzMzIiwiYXVkIjoiYXJuOmF3czpzc286OjEyMzQ1Njc4OTAxMjphcHBsaWNhdGlvbi9zc29pbnMtMTExMTExMTExMTExL2FwbC0yMjIyMjIyMjIyMjIiLCJhd3M6aW5zdGFuY2VfYXJuIjoiYXJuOmF3czpzc286OjppbnN0YW5jZS9zc29pbnMtMTExMTExMTExMTExIiwiYXdzOmNyZWRlbnRpYWxfaWQiOiJfWlIyTjZhVkJqMjdGUEtheWpfcEtwVjc3QVBERl80MXB4ZXRfWWpJdUpONlVJR2RBdkpFWEFNUExFQ1JFRElEIiwiYXV0aF90aW1lIjoiMjAyMC0wMS0yMlQxMjo0NToyOVoiLCJleHAiOjE1Nzk3Mjk1MjksImlhdCI6MTU3OTcyNTkyOX0.5SYiW1kMsuUr7nna-l5tlakM0GNbMHvIM2_n0QD23jM", # issued_token_type: "urn:ietf:params:oauth:token-type:access_token", # scope: [ # "openid", # "aws", # "sts:identity_context", # ], # token_type: "Bearer", # } # # @example Request syntax with placeholder values # # resp = client.create_token_with_iam({ # client_id: "ClientId", # required # grant_type: "GrantType", # required # code: "AuthCode", # refresh_token: "RefreshToken", # assertion: "Assertion", # scope: ["Scope"], # redirect_uri: "URI", # subject_token: "SubjectToken", # subject_token_type: "TokenTypeURI", # requested_token_type: "TokenTypeURI", # code_verifier: "CodeVerifier", # }) # # @example Response structure # # resp.access_token #=> String # resp.token_type #=> String # resp.expires_in #=> Integer # resp.refresh_token #=> String # resp.id_token #=> String # resp.issued_token_type #=> String # resp.scope #=> Array # resp.scope[0] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/CreateTokenWithIAM AWS API Documentation # # @overload create_token_with_iam(params = {}) # @param [Hash] params ({}) def create_token_with_iam(params = {}, options = {}) req = build_request(:create_token_with_iam, params) req.send_request(options) end # Registers a client with IAM Identity Center. This allows clients to # initiate device authorization. The output should be persisted for # reuse through many authentication requests. # # @option params [required, String] :client_name # The friendly name of the client. # # @option params [required, String] :client_type # The type of client. The service supports only `public` as a client # type. Anything other than public will be rejected by the service. # # @option params [Array] :scopes # The list of scopes that are defined by the client. Upon authorization, # this list is used to restrict permissions when granting an access # token. # # @option params [Array] :redirect_uris # The list of redirect URI that are defined by the client. At completion # of authorization, this list is used to restrict what locations the # user agent can be redirected back to. # # @option params [Array] :grant_types # The list of OAuth 2.0 grant types that are defined by the client. This # list is used to restrict the token granting flows available to the # client. # # @option params [String] :issuer_url # The IAM Identity Center Issuer URL associated with an instance of IAM # Identity Center. This value is needed for user access to resources # through the client. # # @option params [String] :entitled_application_arn # This IAM Identity Center application ARN is used to define # administrator-managed configuration for public client access to # resources. At authorization, the scopes, grants, and redirect URI # available to this client will be restricted by this application # resource. # # @return [Types::RegisterClientResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::RegisterClientResponse#client_id #client_id} => String # * {Types::RegisterClientResponse#client_secret #client_secret} => String # * {Types::RegisterClientResponse#client_id_issued_at #client_id_issued_at} => Integer # * {Types::RegisterClientResponse#client_secret_expires_at #client_secret_expires_at} => Integer # * {Types::RegisterClientResponse#authorization_endpoint #authorization_endpoint} => String # * {Types::RegisterClientResponse#token_endpoint #token_endpoint} => String # # # @example Example: Call OAuth/OIDC /register-client endpoint # # resp = client.register_client({ # client_name: "My IDE Plugin", # client_type: "public", # entitled_application_arn: "arn:aws:sso::ACCOUNTID:application/ssoins-1111111111111111/apl-1111111111111111", # grant_types: [ # "authorization_code", # "refresh_token", # ], # issuer_url: "https://identitycenter.amazonaws.com/ssoins-1111111111111111", # redirect_uris: [ # "127.0.0.1:PORT/oauth/callback", # ], # scopes: [ # "sso:account:access", # "codewhisperer:completions", # ], # }) # # resp.to_h outputs the following: # { # client_id: "_yzkThXVzLWVhc3QtMQEXAMPLECLIENTID", # client_id_issued_at: 1579725929, # client_secret: "VERYLONGSECRETeyJraWQiOiJrZXktMTU2NDAyODA5OSIsImFsZyI6IkhTMzg0In0", # client_secret_expires_at: 1587584729, # } # # @example Request syntax with placeholder values # # resp = client.register_client({ # client_name: "ClientName", # required # client_type: "ClientType", # required # scopes: ["Scope"], # redirect_uris: ["URI"], # grant_types: ["GrantType"], # issuer_url: "URI", # entitled_application_arn: "ArnType", # }) # # @example Response structure # # resp.client_id #=> String # resp.client_secret #=> String # resp.client_id_issued_at #=> Integer # resp.client_secret_expires_at #=> Integer # resp.authorization_endpoint #=> String # resp.token_endpoint #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/RegisterClient AWS API Documentation # # @overload register_client(params = {}) # @param [Hash] params ({}) def register_client(params = {}, options = {}) req = build_request(:register_client, params) req.send_request(options) end # Initiates device authorization by requesting a pair of verification # codes from the authorization service. # # @option params [required, String] :client_id # The unique identifier string for the client that is registered with # IAM Identity Center. This value should come from the persisted result # of the RegisterClient API operation. # # @option params [required, String] :client_secret # A secret string that is generated for the client. This value should # come from the persisted result of the RegisterClient API operation. # # @option params [required, String] :start_url # The URL for the Amazon Web Services access portal. For more # information, see [Using the Amazon Web Services access portal][1] in # the *IAM Identity Center User Guide*. # # # # [1]: https://docs.aws.amazon.com/singlesignon/latest/userguide/using-the-portal.html # # @return [Types::StartDeviceAuthorizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::StartDeviceAuthorizationResponse#device_code #device_code} => String # * {Types::StartDeviceAuthorizationResponse#user_code #user_code} => String # * {Types::StartDeviceAuthorizationResponse#verification_uri #verification_uri} => String # * {Types::StartDeviceAuthorizationResponse#verification_uri_complete #verification_uri_complete} => String # * {Types::StartDeviceAuthorizationResponse#expires_in #expires_in} => Integer # * {Types::StartDeviceAuthorizationResponse#interval #interval} => Integer # # # @example Example: Call OAuth/OIDC /start-device-authorization endpoint # # resp = client.start_device_authorization({ # client_id: "_yzkThXVzLWVhc3QtMQEXAMPLECLIENTID", # client_secret: "VERYLONGSECRETeyJraWQiOiJrZXktMTU2NDAyODA5OSIsImFsZyI6IkhTMzg0In0", # start_url: "https://identitycenter.amazonaws.com/ssoins-111111111111", # }) # # resp.to_h outputs the following: # { # device_code: "yJraWQiOiJrZXktMTU2Njk2ODA4OCIsImFsZyI6IkhTMzIn0EXAMPLEDEVICECODE", # expires_in: 1579729529, # interval: 1, # user_code: "makdfsk83yJraWQiOiJrZXktMTU2Njk2sImFsZyI6IkhTMzIn0EXAMPLEUSERCODE", # verification_uri: "https://device.sso.us-west-2.amazonaws.com", # verification_uri_complete: "https://device.sso.us-west-2.amazonaws.com?user_code=makdfsk83yJraWQiOiJrZXktMTU2Njk2sImFsZyI6IkhTMzIn0EXAMPLEUSERCODE", # } # # @example Request syntax with placeholder values # # resp = client.start_device_authorization({ # client_id: "ClientId", # required # client_secret: "ClientSecret", # required # start_url: "URI", # required # }) # # @example Response structure # # resp.device_code #=> String # resp.user_code #=> String # resp.verification_uri #=> String # resp.verification_uri_complete #=> String # resp.expires_in #=> Integer # resp.interval #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/StartDeviceAuthorization AWS API Documentation # # @overload start_device_authorization(params = {}) # @param [Hash] params ({}) def start_device_authorization(params = {}, options = {}) req = build_request(:start_device_authorization, params) req.send_request(options) end # @!endgroup # @param params ({}) # @api private def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) tracer = config.telemetry_provider.tracer_provider.tracer( Aws::Telemetry.module_to_tracer_name('Aws::SSOOIDC') ) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config, tracer: tracer ) context[:gem_name] = 'aws-sdk-core' context[:gem_version] = '3.205.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated def waiter_names [] end class << self # @api private attr_reader :identifier # @api private def errors_module Errors end end end end