POST

/token

http://oidc.{region}.amazonaws.com/token

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.

Access Token Required: API Key

Body Params

codestring

The authorization code received from the authorization service. This parameter is required to perform an authorization grant request to get access to a token.

scopearray

The list of scopes that is defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

clientIdstringrequired

The unique identifier string for each client. This value should come from the persisted result of the <a>RegisterClient</a> API.

grantTypestringrequired

Supports grant types for the authorization code, refresh token, and device code request. For device code requests, specify the following value: <code>urn:ietf:params:oauth:grant-type:device_code </code> For information about how to obtain the device code, see the <a>StartDeviceAuthorization</a> topic.

deviceCodestring

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 <a>StartDeviceAuthorization</a> API.

redirectUristring

The location of the application that will receive the authorization code. Users authorize the service to send the request to this location.

clientSecretstringrequired

A secret string generated for the client. This value should come from the persisted result of the <a>RegisterClient</a> API.

refreshTokenstring

Currently, <code>refreshToken</code> 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 <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html">IAM Identity Center OIDC API Reference</a>. The token used to obtain an access token in the event that the access token is invalid or expired.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://oidc.{region}.amazonaws.com/token' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}