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.
", "authtype":"none" }, "RegisterClient":{ "name":"RegisterClient", "http":{ "method":"POST", "requestUri":"/client/register" }, "input":{"shape":"RegisterClientRequest"}, "output":{"shape":"RegisterClientResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InvalidScopeException"}, {"shape":"InvalidClientMetadataException"}, {"shape":"InternalServerException"} ], "documentation":"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.
", "authtype":"none" }, "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" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ "error":{"shape":"Error"}, "error_description":{"shape":"ErrorDescription"} }, "documentation":"You do not have sufficient access to perform this action.
", "error":{"httpStatusCode":400}, "exception":true }, "AccessToken":{"type":"string"}, "AuthCode":{"type":"string"}, "AuthorizationPendingException":{ "type":"structure", "members":{ "error":{"shape":"Error"}, "error_description":{"shape":"ErrorDescription"} }, "documentation":"Indicates that a request to authorize a client with an access user session token is pending.
", "error":{"httpStatusCode":400}, "exception":true }, "ClientId":{"type":"string"}, "ClientName":{"type":"string"}, "ClientSecret":{"type":"string"}, "ClientType":{"type":"string"}, "CreateTokenRequest":{ "type":"structure", "required":[ "clientId", "clientSecret", "grantType" ], "members":{ "clientId":{ "shape":"ClientId", "documentation":"The unique identifier string for each client. This value should come from the persisted 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 grant types for the authorization code, refresh token, and device code request. For device code requests, specify the following value:
urn:ietf:params:oauth:grant-type:device_code
For information about how to obtain the device code, see the StartDeviceAuthorization topic.
" }, "deviceCode":{ "shape":"DeviceCode", "documentation":"Used only when calling this API for the device code grant type. This short-term code is used to identify this authentication attempt. This should come from an in-memory reference to the result of the StartDeviceAuthorization API.
" }, "code":{ "shape":"AuthCode", "documentation":"The authorization code received from the authorization service. This parameter is required to perform an authorization grant request to get access to a token.
" }, "refreshToken":{ "shape":"RefreshToken", "documentation":"Currently, refreshToken is not yet implemented and is not 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.
The token used to obtain an access token in the event that the access token is invalid or expired.
" }, "scope":{ "shape":"Scopes", "documentation":"The list of scopes that is defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.
" }, "redirectUri":{ "shape":"URI", "documentation":"The location of the application that will receive the authorization code. Users authorize the service to send the request to this location.
" } } }, "CreateTokenResponse":{ "type":"structure", "members":{ "accessToken":{ "shape":"AccessToken", "documentation":"An opaque token to access IAM Identity Center resources assigned to a user.
" }, "tokenType":{ "shape":"TokenType", "documentation":"Used to notify the client that the returned token is an access token. The supported type is BearerToken.
Indicates the time in seconds when an access token will expire.
" }, "refreshToken":{ "shape":"RefreshToken", "documentation":"Currently, refreshToken is not yet implemented and is not 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 token that, if present, can be used to refresh a previously issued access token that might have expired.
" }, "idToken":{ "shape":"IdToken", "documentation":"Currently, idToken is not yet implemented and is not 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.
The identifier of the user that associated with the access token, if present.
" } } }, "DeviceCode":{"type":"string"}, "Error":{"type":"string"}, "ErrorDescription":{"type":"string"}, "ExpirationInSeconds":{"type":"integer"}, "ExpiredTokenException":{ "type":"structure", "members":{ "error":{"shape":"Error"}, "error_description":{"shape":"ErrorDescription"} }, "documentation":"Indicates that the token issued by the service is expired and is no longer valid.
", "error":{"httpStatusCode":400}, "exception":true }, "GrantType":{"type":"string"}, "IdToken":{"type":"string"}, "InternalServerException":{ "type":"structure", "members":{ "error":{"shape":"Error"}, "error_description":{"shape":"ErrorDescription"} }, "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"}, "error_description":{"shape":"ErrorDescription"} }, "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.
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"}, "error_description":{"shape":"ErrorDescription"} }, "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 }, "InvalidRequestException":{ "type":"structure", "members":{ "error":{"shape":"Error"}, "error_description":{"shape":"ErrorDescription"} }, "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 }, "InvalidScopeException":{ "type":"structure", "members":{ "error":{"shape":"Error"}, "error_description":{"shape":"ErrorDescription"} }, "documentation":"Indicates that the scope provided in the request is invalid.
", "error":{"httpStatusCode":400}, "exception":true }, "LongTimeStampType":{"type":"long"}, "RefreshToken":{"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.
" } } }, "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.
The endpoint where the client can request authorization.
" }, "tokenEndpoint":{ "shape":"URI", "documentation":"The endpoint where the client can get an access token.
" } } }, "Scope":{"type":"string"}, "Scopes":{ "type":"list", "member":{"shape":"Scope"} }, "SlowDownException":{ "type":"structure", "members":{ "error":{"shape":"Error"}, "error_description":{"shape":"ErrorDescription"} }, "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 AWS access portal. For more information, see Using the AWS 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.
" } } }, "TokenType":{"type":"string"}, "URI":{"type":"string"}, "UnauthorizedClientException":{ "type":"structure", "members":{ "error":{"shape":"Error"}, "error_description":{"shape":"ErrorDescription"} }, "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.
Indicates that the grant type in the request is not supported by the service.
", "error":{"httpStatusCode":400}, "exception":true }, "UserCode":{"type":"string"} }, "documentation":"AWS IAM Identity Center (successor to AWS Single Sign-On) OpenID Connect (OIDC) is a web service that enables a client (such as AWS 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.
Although AWS Single Sign-On was renamed, the sso and identitystore API namespaces will continue to retain their original name for backward compatibility purposes. For more information, see IAM Identity Center rename.
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 AWS CLI. Support for other OIDC flows frequently needed for native applications, such as Authorization Code Flow (+ PKCE), will be addressed in future releases.
The service emits only OIDC access tokens, such that obtaining a new token (For example, token refresh) requires explicit user re-authentication.
The access tokens provided by this service grant access to all AWS 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 AWS Auth (“sigv4”) credentials for use with IAM-protected AWS 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.
" }