Class: Aws::Signin::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Signin::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-core/lib/aws-sdk-signin/client.rb
Overview
An API client for Signin. To construct a client, you need to configure a :region and :credentials.
client = Aws::Signin::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_o_auth_2_token(params = {}) ⇒ Types::CreateOAuth2TokenResponse
CreateOAuth2Token API.
-
#delete_console_authorization_configuration(params = {}) ⇒ Types::DeleteConsoleAuthorizationConfigurationOutput
Delete console authorization configuration with automatic scope detection.
-
#delete_resource_permission_statement(params = {}) ⇒ Struct
Remove a permission statement from the account's SignIn resource-based policy.
-
#get_console_authorization_configuration(params = {}) ⇒ Types::GetConsoleAuthorizationConfigurationOutput
Get console authorization configuration with automatic scope detection.
-
#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyOutput
Retrieve the account's consolidated SignIn resource-based policy.
-
#list_resource_permission_statements(params = {}) ⇒ Types::ListResourcePermissionStatementsOutput
Retrieve all permission statements in the account's SignIn resource-based policy.
-
#put_console_authorization_configuration(params = {}) ⇒ Types::PutConsoleAuthorizationConfigurationOutput
Enable console authorization configuration with automatic scope detection.
-
#put_resource_permission_statement(params = {}) ⇒ Types::PutResourcePermissionStatementOutput
Create a permission statement in the account's SignIn resource-based policy.
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.
471 472 473 |
# File 'gems/aws-sdk-core/lib/aws-sdk-signin/client.rb', line 471 def initialize(*args) super end |
Instance Method Details
#create_o_auth_2_token(params = {}) ⇒ Types::CreateOAuth2TokenResponse
CreateOAuth2Token API
Path: /v1/token Request Method: POST Content-Type: application/json or application/x-www-form-urlencoded
This API implements OAuth 2.0 flows for AWS Sign-In CLI clients, supporting both:
- Authorization code redemption (grant_type=authorization_code) - NOT idempotent
- Token refresh (grant_type=refresh_token) - Idempotent within token validity window
The operation behavior is determined by the grant_type parameter in the request body:
Authorization Code Flow (NOT Idempotent):
- JSON or form-encoded body with client_id, grant_type=authorization_code, code, redirect_uri, code_verifier
- Returns access_token, token_type, expires_in, refresh_token, and id_token
- Each authorization code can only be used ONCE for security (prevents replay attacks)
Token Refresh Flow (Idempotent):
- JSON or form-encoded body with client_id, grant_type=refresh_token, refresh_token
- Returns access_token, token_type, expires_in, and refresh_token (no id_token)
- Multiple calls with same refresh_token return consistent results within validity window
Authentication and authorization:
- Confidential clients: sigv4 signing required with signin:ExchangeToken permissions
- CLI clients (public): authn/authz skipped based on client_id & grant_type
Note: This operation cannot be marked as @idempotent because it handles both idempotent (token refresh) and non-idempotent (auth code redemption) flows in a single endpoint.
557 558 559 560 |
# File 'gems/aws-sdk-core/lib/aws-sdk-signin/client.rb', line 557 def create_o_auth_2_token(params = {}, = {}) req = build_request(:create_o_auth_2_token, params) req.send_request() end |
#delete_console_authorization_configuration(params = {}) ⇒ Types::DeleteConsoleAuthorizationConfigurationOutput
Delete console authorization configuration with automatic scope detection
590 591 592 593 |
# File 'gems/aws-sdk-core/lib/aws-sdk-signin/client.rb', line 590 def (params = {}, = {}) req = build_request(:delete_console_authorization_configuration, params) req.send_request() end |
#delete_resource_permission_statement(params = {}) ⇒ Struct
Remove a permission statement from the account's SignIn resource-based policy
620 621 622 623 |
# File 'gems/aws-sdk-core/lib/aws-sdk-signin/client.rb', line 620 def (params = {}, = {}) req = build_request(:delete_resource_permission_statement, params) req.send_request() end |
#get_console_authorization_configuration(params = {}) ⇒ Types::GetConsoleAuthorizationConfigurationOutput
Get console authorization configuration with automatic scope detection
652 653 654 655 |
# File 'gems/aws-sdk-core/lib/aws-sdk-signin/client.rb', line 652 def (params = {}, = {}) req = build_request(:get_console_authorization_configuration, params) req.send_request() end |
#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyOutput
Retrieve the account's consolidated SignIn resource-based policy
682 683 684 685 |
# File 'gems/aws-sdk-core/lib/aws-sdk-signin/client.rb', line 682 def get_resource_policy(params = {}, = {}) req = build_request(:get_resource_policy, params) req.send_request() end |
#list_resource_permission_statements(params = {}) ⇒ Types::ListResourcePermissionStatementsOutput
Retrieve all permission statements in the account's SignIn resource-based policy
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
724 725 726 727 |
# File 'gems/aws-sdk-core/lib/aws-sdk-signin/client.rb', line 724 def (params = {}, = {}) req = build_request(:list_resource_permission_statements, params) req.send_request() end |
#put_console_authorization_configuration(params = {}) ⇒ Types::PutConsoleAuthorizationConfigurationOutput
Enable console authorization configuration with automatic scope detection
757 758 759 760 |
# File 'gems/aws-sdk-core/lib/aws-sdk-signin/client.rb', line 757 def (params = {}, = {}) req = build_request(:put_console_authorization_configuration, params) req.send_request() end |
#put_resource_permission_statement(params = {}) ⇒ Types::PutResourcePermissionStatementOutput
Create a permission statement in the account's SignIn resource-based policy
818 819 820 821 |
# File 'gems/aws-sdk-core/lib/aws-sdk-signin/client.rb', line 818 def (params = {}, = {}) req = build_request(:put_resource_permission_statement, params) req.send_request() end |