/AWS1/CL_SSI=>CREATETOKENWITHIAM()¶
About CreateTokenWithIAM¶
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 Amazon Web Services accounts or to access application APIs using bearer
authentication.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_CLIENTID TYPE /AWS1/SSICLIENTID /AWS1/SSICLIENTID¶
The unique identifier string for the client or application. This value is an application ARN that has OAuth grants configured.
IV_GRANTTYPE TYPE /AWS1/SSIGRANTTYPE /AWS1/SSIGRANTTYPE¶
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_codeRefresh Token -
refresh_tokenJWT Bearer -
urn:ietf:params:oauth:grant-type:jwt-bearerToken Exchange -
urn:ietf:params:oauth:grant-type:token-exchange
Optional arguments:¶
IV_CODE TYPE /AWS1/SSIAUTHCODE /AWS1/SSIAUTHCODE¶
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.
IV_REFRESHTOKEN TYPE /AWS1/SSIREFRESHTOKEN /AWS1/SSIREFRESHTOKEN¶
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.
IV_ASSERTION TYPE /AWS1/SSIASSERTION /AWS1/SSIASSERTION¶
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.
IT_SCOPE TYPE /AWS1/CL_SSISCOPES_W=>TT_SCOPES TT_SCOPES¶
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.
IV_REDIRECTURI TYPE /AWS1/SSIURI /AWS1/SSIURI¶
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.
IV_SUBJECTTOKEN TYPE /AWS1/SSISUBJECTTOKEN /AWS1/SSISUBJECTTOKEN¶
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.
IV_SUBJECTTOKENTYPE TYPE /AWS1/SSITOKENTYPEURI /AWS1/SSITOKENTYPEURI¶
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
IV_REQUESTEDTOKENTYPE TYPE /AWS1/SSITOKENTYPEURI /AWS1/SSITOKENTYPEURI¶
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_tokenRefresh Token -
urn:ietf:params:oauth:token-type:refresh_token
IV_CODEVERIFIER TYPE /AWS1/SSICODEVERIFIER /AWS1/SSICODEVERIFIER¶
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.