Creates and returns access and refresh tokens for clients that are authenticated using client secrets. The access token can be used to fetch short-lived credentials for the assigned AWS accounts or to access application APIs using bearer authentication.
Creates and returns access and refresh tokens for authorized client applications that are authenticated using any IAM entity, such as a service role or user. These tokens might contain defined scopes that specify permissions such as read:profile or write:data. Through downscoping, you can use the scopes parameter to request tokens with reduced permissions compared to the original client application's permissions or, if applicable, the refresh token's scopes. The access token can be used to fetch short-lived credentials for the assigned Amazon Web Services accounts or to access application APIs using bearer authentication.
This API is used with Signature Version 4. For more information, see Amazon Web Services Signature Version 4 for API Requests.
Registers a public client with IAM Identity Center. This allows clients to perform authorization using the authorization code grant with Proof Key for Code Exchange (PKCE) or the device code grant.
", "authtype":"none", "auth":["smithy.api#noAuth"] }, "StartDeviceAuthorization":{ "name":"StartDeviceAuthorization", "http":{ "method":"POST", "requestUri":"/device_authorization" }, "input":{"shape":"StartDeviceAuthorizationRequest"}, "output":{"shape":"StartDeviceAuthorizationResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidClientException"}, {"shape":"UnauthorizedClientException"}, {"shape":"SlowDownException"}, {"shape":"InternalServerException"} ], "documentation":"Initiates device authorization by requesting a pair of verification codes from the authorization service.
", "authtype":"none", "auth":["smithy.api#noAuth"] } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ "error":{ "shape":"Error", "documentation":"Single error code. For this exception the value will be access_denied.
A string that uniquely identifies a reason for the error.
" }, "error_description":{ "shape":"ErrorDescription", "documentation":"Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
" } }, "documentation":"You do not have sufficient access to perform this action.
", "error":{"httpStatusCode":400}, "exception":true }, "AccessDeniedExceptionReason":{ "type":"string", "enum":["KMS_AccessDeniedException"] }, "AccessToken":{ "type":"string", "sensitive":true }, "ArnType":{"type":"string"}, "Assertion":{ "type":"string", "sensitive":true }, "AuthCode":{"type":"string"}, "AuthorizationPendingException":{ "type":"structure", "members":{ "error":{ "shape":"Error", "documentation":"Single error code. For this exception the value will be authorization_pending.
Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
" } }, "documentation":"Indicates that a request to authorize a client with an access user session token is pending.
", "error":{"httpStatusCode":400}, "exception":true }, "AwsAdditionalDetails":{ "type":"structure", "members":{ "identityContext":{ "shape":"IdentityContext", "documentation":"The trusted context assertion is signed and encrypted by STS. It provides access to sts:identity_context claim in the idToken without JWT parsing
Identity context comprises information that Amazon Web Services services use to make authorization decisions when they receive requests.
" } }, "documentation":"This structure contains Amazon Web Services-specific parameter extensions and the identity context.
" }, "ClientId":{"type":"string"}, "ClientName":{"type":"string"}, "ClientSecret":{ "type":"string", "sensitive":true }, "ClientType":{"type":"string"}, "CodeVerifier":{ "type":"string", "sensitive":true }, "CreateTokenRequest":{ "type":"structure", "required":[ "clientId", "clientSecret", "grantType" ], "members":{ "clientId":{ "shape":"ClientId", "documentation":"The unique identifier string for the client or application. This value comes from the result of the RegisterClient API.
" }, "clientSecret":{ "shape":"ClientSecret", "documentation":"A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.
" }, "grantType":{ "shape":"GrantType", "documentation":"Supports the following OAuth grant types: Authorization Code, Device Code, and Refresh Token. Specify one of the following values, depending on the grant type that you want:
* Authorization Code - authorization_code
* Device Code - urn:ietf:params:oauth:grant-type:device_code
* Refresh Token - refresh_token
Used only when calling this API for the Device Code grant type. This short-lived code is used to identify this authorization request. This comes from the result of the StartDeviceAuthorization API.
" }, "code":{ "shape":"AuthCode", "documentation":"Used only when calling this API for the Authorization Code grant type. The short-lived code is used to identify this authorization request.
" }, "refreshToken":{ "shape":"RefreshToken", "documentation":"Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-lived 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.
" }, "scope":{ "shape":"Scopes", "documentation":"The list of scopes for which authorization is requested. This parameter has no effect; the access token will always include all scopes configured during client registration.
" }, "redirectUri":{ "shape":"URI", "documentation":"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.
" }, "codeVerifier":{ "shape":"CodeVerifier", "documentation":"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.
" } } }, "CreateTokenResponse":{ "type":"structure", "members":{ "accessToken":{ "shape":"AccessToken", "documentation":"A bearer token to access Amazon Web Services accounts and applications assigned to a user.
" }, "tokenType":{ "shape":"TokenType", "documentation":"Used to notify the client that the returned token is an access token. The supported token type is Bearer.
Indicates the time in seconds when an access token will expire.
" }, "refreshToken":{ "shape":"RefreshToken", "documentation":"A token that, if present, can be used to refresh a previously issued access token that might have expired.
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.
" }, "idToken":{ "shape":"IdToken", "documentation":"The idToken is not implemented or supported. 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.
A JSON Web Token (JWT) that identifies who is associated with the issued access token.
" } } }, "CreateTokenWithIAMRequest":{ "type":"structure", "required":[ "clientId", "grantType" ], "members":{ "clientId":{ "shape":"ClientId", "documentation":"The unique identifier string for the client or application. This value is an application ARN that has OAuth grants configured.
" }, "grantType":{ "shape":"GrantType", "documentation":"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
Used only when calling this API for the Authorization Code grant type. This short-lived 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.
" }, "refreshToken":{ "shape":"RefreshToken", "documentation":"Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-lived 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.
" }, "assertion":{ "shape":"Assertion", "documentation":"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.
" }, "scope":{ "shape":"Scopes", "documentation":"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.
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.
" }, "subjectToken":{ "shape":"SubjectToken", "documentation":"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.
" }, "subjectTokenType":{ "shape":"TokenTypeURI", "documentation":"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
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
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.
" } } }, "CreateTokenWithIAMResponse":{ "type":"structure", "members":{ "accessToken":{ "shape":"AccessToken", "documentation":"A bearer token to access Amazon Web Services accounts and applications assigned to a user.
" }, "tokenType":{ "shape":"TokenType", "documentation":"Used to notify the requester that the returned token is an access token. The supported token type is Bearer.
Indicates the time in seconds when an access token will expire.
" }, "refreshToken":{ "shape":"RefreshToken", "documentation":"A token that, if present, can be used to refresh a previously issued access token that might have expired.
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.
" }, "idToken":{ "shape":"IdToken", "documentation":"A JSON Web Token (JWT) that identifies the user associated with the issued access token.
" }, "issuedTokenType":{ "shape":"TokenTypeURI", "documentation":"Indicates the type of tokens that are issued by IAM Identity Center. 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
The list of scopes for which authorization is granted. The access token that is issued is limited to the scopes that are granted.
" }, "awsAdditionalDetails":{ "shape":"AwsAdditionalDetails", "documentation":"A structure containing information from IAM Identity Center managed user and group information.
" } } }, "DeviceCode":{"type":"string"}, "Error":{"type":"string"}, "ErrorDescription":{"type":"string"}, "ExpirationInSeconds":{"type":"integer"}, "ExpiredTokenException":{ "type":"structure", "members":{ "error":{ "shape":"Error", "documentation":"Single error code. For this exception the value will be expired_token.
Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
" } }, "documentation":"Indicates that the token issued by the service is expired and is no longer valid.
", "error":{"httpStatusCode":400}, "exception":true }, "GrantType":{"type":"string"}, "GrantTypes":{ "type":"list", "member":{"shape":"GrantType"} }, "IdToken":{ "type":"string", "sensitive":true }, "IdentityContext":{"type":"string"}, "InternalServerException":{ "type":"structure", "members":{ "error":{ "shape":"Error", "documentation":"Single error code. For this exception the value will be server_error.
Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
" } }, "documentation":"Indicates that an error from the service occurred while trying to process a request.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "IntervalInSeconds":{"type":"integer"}, "InvalidClientException":{ "type":"structure", "members":{ "error":{ "shape":"Error", "documentation":"Single error code. For this exception the value will be invalid_client.
Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
" } }, "documentation":"Indicates that the clientId or clientSecret in the request is invalid. For example, this can occur when a client sends an incorrect clientId or an expired clientSecret.
Single error code. For this exception the value will be invalid_client_metadata.
Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
" } }, "documentation":"Indicates that the client information sent in the request during registration is invalid.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidGrantException":{ "type":"structure", "members":{ "error":{ "shape":"Error", "documentation":"Single error code. For this exception the value will be invalid_grant.
Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
" } }, "documentation":"Indicates that a request contains an invalid grant. This can occur if a client makes a CreateToken request with an invalid grant type.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidRedirectUriException":{ "type":"structure", "members":{ "error":{ "shape":"Error", "documentation":"Single error code. For this exception the value will be invalid_redirect_uri.
Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
" } }, "documentation":"Indicates that one or more redirect URI in the request is not supported for this operation.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidRequestException":{ "type":"structure", "members":{ "error":{ "shape":"Error", "documentation":"Single error code. For this exception the value will be invalid_request.
A string that uniquely identifies a reason for the error.
" }, "error_description":{ "shape":"ErrorDescription", "documentation":"Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
" } }, "documentation":"Indicates that something is wrong with the input to the request. For example, a required parameter might be missing or out of range.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidRequestExceptionReason":{ "type":"string", "enum":[ "KMS_NotFoundException", "KMS_InvalidKeyUsageException", "KMS_InvalidStateException", "KMS_DisabledException" ] }, "InvalidRequestRegionException":{ "type":"structure", "members":{ "error":{ "shape":"Error", "documentation":"Single error code. For this exception the value will be invalid_request.
Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
" }, "endpoint":{ "shape":"Location", "documentation":"Indicates the IAM Identity Center endpoint which the requester may call with this token.
" }, "region":{ "shape":"Region", "documentation":"Indicates the region which the requester may call with this token.
" } }, "documentation":"Indicates that a token provided as input to the request was issued by and is only usable by calling IAM Identity Center endpoints in another region.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidScopeException":{ "type":"structure", "members":{ "error":{ "shape":"Error", "documentation":"Single error code. For this exception the value will be invalid_scope.
Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
" } }, "documentation":"Indicates that the scope provided in the request is invalid.
", "error":{"httpStatusCode":400}, "exception":true }, "Location":{"type":"string"}, "LongTimeStampType":{"type":"long"}, "RedirectUris":{ "type":"list", "member":{"shape":"URI"} }, "RefreshToken":{ "type":"string", "sensitive":true }, "Region":{"type":"string"}, "RegisterClientRequest":{ "type":"structure", "required":[ "clientName", "clientType" ], "members":{ "clientName":{ "shape":"ClientName", "documentation":"The friendly name of the client.
" }, "clientType":{ "shape":"ClientType", "documentation":"The type of client. The service supports only public as a client type. Anything other than public will be rejected by the service.
The list of scopes that are defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.
" }, "redirectUris":{ "shape":"RedirectUris", "documentation":"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.
" }, "grantTypes":{ "shape":"GrantTypes", "documentation":"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. Supports the following OAuth 2.0 grant types: Authorization Code, Device Code, and Refresh Token.
* Authorization Code - authorization_code
* Device Code - urn:ietf:params:oauth:grant-type:device_code
* Refresh Token - refresh_token
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.
" }, "entitledApplicationArn":{ "shape":"ArnType", "documentation":"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.
" } } }, "RegisterClientResponse":{ "type":"structure", "members":{ "clientId":{ "shape":"ClientId", "documentation":"The unique identifier string for each client. This client uses this identifier to get authenticated by the service in subsequent calls.
" }, "clientSecret":{ "shape":"ClientSecret", "documentation":"A secret string generated for the client. The client will use this string to get authenticated by the service in subsequent calls.
" }, "clientIdIssuedAt":{ "shape":"LongTimeStampType", "documentation":"Indicates the time at which the clientId and clientSecret were issued.
Indicates the time at which the clientId and clientSecret will become invalid.
An endpoint that the client can use to request authorization.
" }, "tokenEndpoint":{ "shape":"URI", "documentation":"An endpoint that the client can use to create tokens.
" } } }, "Scope":{"type":"string"}, "Scopes":{ "type":"list", "member":{"shape":"Scope"} }, "SlowDownException":{ "type":"structure", "members":{ "error":{ "shape":"Error", "documentation":"Single error code. For this exception the value will be slow_down.
Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
" } }, "documentation":"Indicates that the client is making the request too frequently and is more than the service can handle.
", "error":{"httpStatusCode":400}, "exception":true }, "StartDeviceAuthorizationRequest":{ "type":"structure", "required":[ "clientId", "clientSecret", "startUrl" ], "members":{ "clientId":{ "shape":"ClientId", "documentation":"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.
" }, "clientSecret":{ "shape":"ClientSecret", "documentation":"A secret string that is generated for the client. This value should come from the persisted result of the RegisterClient API operation.
" }, "startUrl":{ "shape":"URI", "documentation":"The URL for the Amazon Web Services access portal. For more information, see Using the Amazon Web Services access portal in the IAM Identity Center User Guide.
" } } }, "StartDeviceAuthorizationResponse":{ "type":"structure", "members":{ "deviceCode":{ "shape":"DeviceCode", "documentation":"The short-lived code that is used by the device when polling for a session token.
" }, "userCode":{ "shape":"UserCode", "documentation":"A one-time user verification code. This is needed to authorize an in-use device.
" }, "verificationUri":{ "shape":"URI", "documentation":"The URI of the verification page that takes the userCode to authorize the device.
An alternate URL that the client can use to automatically launch a browser. This process skips the manual step in which the user visits the verification page and enters their code.
" }, "expiresIn":{ "shape":"ExpirationInSeconds", "documentation":"Indicates the number of seconds in which the verification code will become invalid.
" }, "interval":{ "shape":"IntervalInSeconds", "documentation":"Indicates the number of seconds the client must wait between attempts when polling for a session.
" } } }, "SubjectToken":{ "type":"string", "sensitive":true }, "TokenType":{"type":"string"}, "TokenTypeURI":{"type":"string"}, "URI":{"type":"string"}, "UnauthorizedClientException":{ "type":"structure", "members":{ "error":{ "shape":"Error", "documentation":"Single error code. For this exception the value will be unauthorized_client.
Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
" } }, "documentation":"Indicates that the client is not currently authorized to make the request. This can happen when a clientId is not issued for a public client.
Single error code. For this exception the value will be unsupported_grant_type.
Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
" } }, "documentation":"Indicates that the grant type in the request is not supported by the service.
", "error":{"httpStatusCode":400}, "exception":true }, "UserCode":{"type":"string"} }, "documentation":"IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI or a native application) to register with IAM Identity Center. The service also enables the client to fetch the user’s access token upon successful authentication and authorization with IAM Identity Center.
API namespaces
IAM Identity Center uses the sso and identitystore API namespaces. IAM Identity Center OpenID Connect uses the sso-oauth namespace.
Considerations for using this guide
Before you begin using this guide, we recommend that you first review the following important information about how the IAM Identity Center OIDC service works.
The IAM Identity Center OIDC service currently implements only the portions of the OAuth 2.0 Device Authorization Grant standard (https://tools.ietf.org/html/rfc8628) that are necessary to enable single sign-on authentication with the CLI.
With older versions of the CLI, the service only emits OIDC access tokens, so to obtain a new token, users must explicitly re-authenticate. To access the OIDC flow that supports token refresh and doesn’t require re-authentication, update to the latest CLI version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh and configurable IAM Identity Center session durations. For more information, see Configure Amazon Web Services access portal session duration .
The access tokens provided by this service grant access to all Amazon Web Services account entitlements assigned to an IAM Identity Center user, not just a particular application.
The documentation in this guide does not describe the mechanism to convert the access token into Amazon Web Services Auth (“sigv4”) credentials for use with IAM-protected Amazon Web Services service endpoints. For more information, see GetRoleCredentials in the IAM Identity Center Portal API Reference Guide.
For general information about IAM Identity Center, see What is IAM Identity Center? in the IAM Identity Center User Guide.
" }