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.
IAM Identity Center uses the sso and identitystore API namespaces.
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.
", "operations": { "CreateToken": "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.
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 AWS accounts or to access application APIs using bearer authentication.
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.
", "StartDeviceAuthorization": "Initiates device authorization by requesting a pair of verification codes from the authorization service.
" }, "shapes": { "AccessDeniedException": { "base": "You do not have sufficient access to perform this action.
", "refs": { } }, "AccessToken": { "base": null, "refs": { "CreateTokenResponse$accessToken": "A bearer token to access AWS accounts and applications assigned to a user.
", "CreateTokenWithIAMResponse$accessToken": "A bearer token to access AWS accounts and applications assigned to a user.
" } }, "Assertion": { "base": null, "refs": { "CreateTokenWithIAMRequest$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.
" } }, "AuthCode": { "base": null, "refs": { "CreateTokenRequest$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.
", "CreateTokenWithIAMRequest$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.
" } }, "AuthorizationPendingException": { "base": "Indicates that a request to authorize a client with an access user session token is pending.
", "refs": { } }, "ClientId": { "base": null, "refs": { "CreateTokenRequest$clientId": "The unique identifier string for the client or application. This value comes from the result of the RegisterClient API.
", "CreateTokenWithIAMRequest$clientId": "The unique identifier string for the client or application. This value is an application ARN that has OAuth grants configured.
", "RegisterClientResponse$clientId": "The unique identifier string for each client. This client uses this identifier to get authenticated by the service in subsequent calls.
", "StartDeviceAuthorizationRequest$clientId": "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.
" } }, "ClientName": { "base": null, "refs": { "RegisterClientRequest$clientName": "The friendly name of the client.
" } }, "ClientSecret": { "base": null, "refs": { "CreateTokenRequest$clientSecret": "A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.
", "RegisterClientResponse$clientSecret": "A secret string generated for the client. The client will use this string to get authenticated by the service in subsequent calls.
", "StartDeviceAuthorizationRequest$clientSecret": "A secret string that is generated for the client. This value should come from the persisted result of the RegisterClient API operation.
" } }, "ClientType": { "base": null, "refs": { "RegisterClientRequest$clientType": "The type of client. The service supports only public as a client type. Anything other than public will be rejected by the service.
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.
", "StartDeviceAuthorizationResponse$deviceCode": "The short-lived code that is used by the device when polling for a session token.
" } }, "Error": { "base": null, "refs": { "AccessDeniedException$error": "Single error code. For this exception the value will be access_denied.
Single error code. For this exception the value will be authorization_pending.
Single error code. For this exception the value will be expired_token.
Single error code. For this exception the value will be server_error.
Single error code. For this exception the value will be invalid_client.
Single error code. For this exception the value will be invalid_client_metadata.
Single error code. For this exception the value will be invalid_grant.
Single error code. For this exception the value will be invalid_request.
Single error code. For this exception the value will be invalid_request.
Single error code. For this exception the value will be invalid_scope.
Single error code. For this exception the value will be slow_down.
Single error code. For this exception the value will be unauthorized_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.
", "AuthorizationPendingException$error_description": "Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
", "ExpiredTokenException$error_description": "Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
", "InternalServerException$error_description": "Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
", "InvalidClientException$error_description": "Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
", "InvalidClientMetadataException$error_description": "Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
", "InvalidGrantException$error_description": "Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
", "InvalidRequestException$error_description": "Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
", "InvalidRequestRegionException$error_description": "Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
", "InvalidScopeException$error_description": "Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
", "SlowDownException$error_description": "Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
", "UnauthorizedClientException$error_description": "Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
", "UnsupportedGrantTypeException$error_description": "Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
" } }, "ExpirationInSeconds": { "base": null, "refs": { "CreateTokenResponse$expiresIn": "Indicates the time in seconds when an access token will expire.
", "CreateTokenWithIAMResponse$expiresIn": "Indicates the time in seconds when an access token will expire.
", "StartDeviceAuthorizationResponse$expiresIn": "Indicates the number of seconds in which the verification code will become invalid.
" } }, "ExpiredTokenException": { "base": "Indicates that the token issued by the service is expired and is no longer valid.
", "refs": { } }, "GrantType": { "base": null, "refs": { "CreateTokenRequest$grantType": "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.
", "CreateTokenWithIAMRequest$grantType": "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
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.
", "CreateTokenWithIAMResponse$idToken": "A JSON Web Token (JWT) that identifies the user associated with the issued access token.
" } }, "InternalServerException": { "base": "Indicates that an error from the service occurred while trying to process a request.
", "refs": { } }, "IntervalInSeconds": { "base": null, "refs": { "StartDeviceAuthorizationResponse$interval": "Indicates the number of seconds the client must wait between attempts when polling for a session.
" } }, "InvalidClientException": { "base": "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.
Indicates that the client information sent in the request during registration is invalid.
", "refs": { } }, "InvalidGrantException": { "base": "Indicates that a request contains an invalid grant. This can occur if a client makes a CreateToken request with an invalid grant type.
", "refs": { } }, "InvalidRequestException": { "base": "Indicates that something is wrong with the input to the request. For example, a required parameter might be missing or out of range.
", "refs": { } }, "InvalidRequestRegionException": { "base": "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.
", "refs": { } }, "InvalidScopeException": { "base": "Indicates that the scope provided in the request is invalid.
", "refs": { } }, "Location": { "base": null, "refs": { "InvalidRequestRegionException$endpoint": "Indicates the IAM Identity Center endpoint which the requester may call with this token.
" } }, "LongTimeStampType": { "base": null, "refs": { "RegisterClientResponse$clientIdIssuedAt": "Indicates the time at which the clientId and clientSecret were issued.
Indicates the time at which the clientId and clientSecret will become invalid.
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.
", "CreateTokenResponse$refreshToken": "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.
", "CreateTokenWithIAMRequest$refreshToken": "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.
", "CreateTokenWithIAMResponse$refreshToken": "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.
" } }, "Region": { "base": null, "refs": { "InvalidRequestRegionException$region": "Indicates the region which the requester may call with this token.
" } }, "RegisterClientRequest": { "base": null, "refs": { } }, "RegisterClientResponse": { "base": null, "refs": { } }, "Scope": { "base": null, "refs": { "Scopes$member": null } }, "Scopes": { "base": null, "refs": { "CreateTokenRequest$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.
", "CreateTokenWithIAMRequest$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.
The list of scopes for which authorization is granted. The access token that is issued is limited to the scopes that are granted.
", "RegisterClientRequest$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.
" } }, "SlowDownException": { "base": "Indicates that the client is making the request too frequently and is more than the service can handle.
", "refs": { } }, "StartDeviceAuthorizationRequest": { "base": null, "refs": { } }, "StartDeviceAuthorizationResponse": { "base": null, "refs": { } }, "SubjectToken": { "base": null, "refs": { "CreateTokenWithIAMRequest$subjectToken": "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.
" } }, "TokenType": { "base": null, "refs": { "CreateTokenResponse$tokenType": "Used to notify the client that the returned token is an access token. The supported token type is Bearer.
Used to notify the requester that the returned token is an access token. The supported token type is Bearer.
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
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
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.
", "CreateTokenWithIAMRequest$redirectUri": "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.
", "RegisterClientResponse$authorizationEndpoint": "An endpoint that the client can use to request authorization.
", "RegisterClientResponse$tokenEndpoint": "An endpoint that the client can use to create tokens.
", "StartDeviceAuthorizationRequest$startUrl": "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$verificationUri": "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.
" } }, "UnauthorizedClientException": { "base": "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.
Indicates that the grant type in the request is not supported by the service.
", "refs": { } }, "UserCode": { "base": null, "refs": { "StartDeviceAuthorizationResponse$userCode": "A one-time user verification code. This is needed to authorize an in-use device.
" } } } }