Class: Aws::SSOOIDC::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SSOOIDC::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-ssooidc/lib/aws-sdk-ssooidc/client.rb
Overview
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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_token(params = {}) ⇒ Types::CreateTokenResponse
Creates and returns an access token for the authorized client.
-
#register_client(params = {}) ⇒ Types::RegisterClientResponse
Registers a client with AWS SSO.
-
#start_device_authorization(params = {}) ⇒ Types::StartDeviceAuthorizationResponse
Initiates device authorization by requesting a pair of verification codes from the authorization service.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
324 325 326 |
# File 'gems/aws-sdk-ssooidc/lib/aws-sdk-ssooidc/client.rb', line 324 def initialize(*args) super end |
Instance Method Details
#create_token(params = {}) ⇒ Types::CreateTokenResponse
Creates and returns an access token for the authorized client. The access token issued will be used to fetch short-term credentials for the assigned roles in the AWS account.
404 405 406 407 |
# File 'gems/aws-sdk-ssooidc/lib/aws-sdk-ssooidc/client.rb', line 404 def create_token(params = {}, = {}) req = build_request(:create_token, params) req.send_request() end |
#register_client(params = {}) ⇒ Types::RegisterClientResponse
Registers a client with AWS SSO. This allows clients to initiate device authorization. The output should be persisted for reuse through many authentication requests.
455 456 457 458 |
# File 'gems/aws-sdk-ssooidc/lib/aws-sdk-ssooidc/client.rb', line 455 def register_client(params = {}, = {}) req = build_request(:register_client, params) req.send_request() end |
#start_device_authorization(params = {}) ⇒ Types::StartDeviceAuthorizationResponse
Initiates device authorization by requesting a pair of verification codes from the authorization service.
510 511 512 513 |
# File 'gems/aws-sdk-ssooidc/lib/aws-sdk-ssooidc/client.rb', line 510 def (params = {}, = {}) req = build_request(:start_device_authorization, params) req.send_request() end |