SigninClient

AWS Sign-In manages authentication for AWS services. This service provides secure authentication flows for accessing AWS resources from the console and developer tools.

Properties

Link copied to clipboard
abstract override val config: SigninClient.Config

SigninClient's configuration

Functions

Link copied to clipboard

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: 1. Authorization code redemption (grant_type=authorization_code) - NOT idempotent 2. 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.

Link copied to clipboard

Delete console authorization configuration with automatic scope detection

Link copied to clipboard

Remove a permission statement from the account's SignIn resource-based policy

Link copied to clipboard
abstract suspend fun getConsoleAuthorizationConfiguration(input: GetConsoleAuthorizationConfigurationRequest = GetConsoleAuthorizationConfigurationRequest { }): GetConsoleAuthorizationConfigurationResponse

Get console authorization configuration with automatic scope detection

Link copied to clipboard
abstract suspend fun getResourcePolicy(input: GetResourcePolicyRequest = GetResourcePolicyRequest { }): GetResourcePolicyResponse

Retrieve the account's consolidated SignIn resource-based policy

Link copied to clipboard
abstract suspend fun listResourcePermissionStatements(input: ListResourcePermissionStatementsRequest = ListResourcePermissionStatementsRequest { }): ListResourcePermissionStatementsResponse

Retrieve all permission statements in the account's SignIn resource-based policy

Link copied to clipboard
abstract suspend fun putConsoleAuthorizationConfiguration(input: PutConsoleAuthorizationConfigurationRequest = PutConsoleAuthorizationConfigurationRequest { }): PutConsoleAuthorizationConfigurationResponse

Enable console authorization configuration with automatic scope detection

Link copied to clipboard
abstract suspend fun putResourcePermissionStatement(input: PutResourcePermissionStatementRequest = PutResourcePermissionStatementRequest { }): PutResourcePermissionStatementResponse

Create a permission statement in the account's SignIn resource-based policy

Inherited functions

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

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: 1. Authorization code redemption (grant_type=authorization_code) - NOT idempotent 2. 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.

Link copied to clipboard

Delete console authorization configuration with automatic scope detection

Link copied to clipboard

Remove a permission statement from the account's SignIn resource-based policy

Link copied to clipboard

Get console authorization configuration with automatic scope detection

Link copied to clipboard

Retrieve the account's consolidated SignIn resource-based policy

Link copied to clipboard

Retrieve all permission statements in the account's SignIn resource-based policy

Link copied to clipboard

Enable console authorization configuration with automatic scope detection

Link copied to clipboard

Create a permission statement in the account's SignIn resource-based policy

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.