[ aws . cognito-idp ]
Exchanges an existing token for a new token that is scoped and audience-bound for a specific downstream service, following the OAuth 2.0 Token Exchange grant type. For more information about the OAuth 2.0 Token Exchange grant type, see RFC 8693 - OAuth 2.0 Token Exchange on the IETF website. Present a SubjectToken , the credential that you already hold, to receive a new token appropriate for calling a specific resource server or audience.
If you also present an ActorToken that identifies an intermediary service, the issued token carries an act claim that identifies the intermediary, and downstream services can distinguish a user acting directly from an intermediary acting on the user’s behalf. If you don’t present an ActorToken , the issued token appears as if the user acted directly.
To use this operation, you must have IAM credentials, or you must present the requesting app client’s ClientId and, if the client has a secret, ClientSecret , in the request.
The requesting app client must have ALLOW_TOKEN_EXCHANGE_IMPERSONATION or ALLOW_TOKEN_EXCHANGE_DELEGATION in its ExplicitAuthFlows (depending on whether you include an ActorToken ), or the request fails.
See also: AWS API Documentation
get-derived-token
--client-id <value>
[--client-secret <value>]
--subject-token <value>
--subject-token-type <value>
[--subject-token-provider-name <value>]
[--actor-token <value>]
[--actor-token-type <value>]
[--actor-token-provider-name <value>]
[--scopes <value>]
[--audiences <value>]
[--resources <value>]
[--requested-token-type <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]
--client-id (string) [required]
The ID of the app client that requests the token exchange.
Constraints:
- min:
1- max:
128- pattern:
[\w+]+
--client-secret (string)
The client secret of the requested app client, if the client has a secret.
Constraints:
- min:
24- max:
64- pattern:
[\w+]+
--subject-token (string) [required]
The token that you want to exchange for a new token. This is the credential that represents the identity of the party on behalf of whom the request is being made.
Constraints:
- min:
0- max:
131072- pattern:
[A-Za-z0-9-_+/=.]+
--subject-token-type (string) [required]
The type of the
SubjectTokenthat you want to exchange. Valid values:
ACCESS_TOKEN– The subject token is an access token.ID_TOKEN– The subject token is an ID token.SAML2– The subject token is a SAML 2.0 assertion.Possible values:
ACCESS_TOKENID_TOKENSAML2
--subject-token-provider-name (string)
The name of the third-party identity provider that issued the
SubjectToken, if the subject token isn’t a Amazon Cognito token. Provide this value when yourSubjectTokencame from a SAML or OIDC provider that you registered with your user pool, so that Amazon Cognito can validate it against that provider’s configuration. Omit this parameter for a Amazon Cognito ID or access token.Constraints:
- min:
1- max:
32- pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}\p{Z}]+
--actor-token (string)
A token that identifies the intermediary service that is exchanging the token on behalf of the user. When you provide an
ActorToken, the token that Amazon Cognito issues carries anactclaim that identifies the intermediary, so that downstream services can distinguish a user acting directly from an intermediary acting on the user’s behalf.Constraints:
- min:
0- max:
131072- pattern:
[A-Za-z0-9-_+/=.]+
--actor-token-type (string)
The type of the
ActorTokenthat you provide. Required when you provide anActorToken. Valid values:
ACCESS_TOKEN– The actor token is an access token.ID_TOKEN– The actor token is an ID token.SAML2– The actor token is a SAML 2.0 assertion.Possible values:
ACCESS_TOKENID_TOKENSAML2
--actor-token-provider-name (string)
The name of the third-party identity provider that issued the
ActorToken, if the actor token isn’t a Amazon Cognito token.Constraints:
- min:
1- max:
32- pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}\p{Z}]+
--scopes (list)
The scopes that you want the new token to have. Amazon Cognito issues a token with the intersection of these requested scopes, the scopes of your
SubjectToken, and the scopes that are allowed for the requesting app client. If you don’t specify any scopes, Amazon Cognito issues a token with the same scopes as yourSubjectToken.Constraints:
- max:
50(string)
Constraints:
- min:
1- max:
256- pattern:
[\x21\x23-\x5B\x5D-\x7E]+
Syntax:
"string" "string" ...
--audiences (list)
The logical name of the target service where you intend to use the issued token. You can’t request both
AudiencesandResourcesin the same request.Constraints:
- min:
0- max:
1(string)
Constraints:
- min:
1- max:
256- pattern:
[\x21\x23-\x5B\x5D-\x7E]+
Syntax:
"string" "string" ...
--resources (list)
The identifier of a resource server in your user pool where you intend to use the issued token. You can’t request both
ResourcesandAudiencesin the same request.Constraints:
- min:
0- max:
1(string)
Constraints:
- min:
1- max:
256- pattern:
[\x21\x23-\x5B\x5D-\x7E]+
Syntax:
"string" "string" ...
--requested-token-type (string)
The type of token that you want Amazon Cognito to issue. Valid values:
ACCESS_TOKEN– Issues an access token.ID_TOKEN– Issues an ID token.Amazon Cognito can’t issue a SAML assertion, so
SAML2isn’t a valid value for this parameter.Possible values:
ACCESS_TOKENID_TOKEN
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
--cli-error-format (string)
The formatting style for error output. By default, errors are displayed in enhanced format.
--help (boolean)
Display help for the command/subcommand.
IssuedToken -> (string)
The token that Amazon Cognito issued in response to the token exchange request.
Constraints:
- pattern:
[A-Za-z0-9-_=.]+
IssuedTokenType -> (string)
The type of the token in the
IssuedTokenparameter. Valid values:
ACCESS_TOKEN– The issued token is an access token.ID_TOKEN– The issued token is an ID token.Possible values:
ACCESS_TOKENID_TOKEN
TokenType -> (string)
The type of the issued token. For example,
Bearer.Possible values:
BearerN_A
ExpiresIn -> (integer)
The number of seconds until the issued token expires.
Scopes -> (list)
The scopes that Amazon Cognito granted in the issued token.
Constraints:
- max:
50(string)
Constraints:
- min:
1- max:
256- pattern:
[\x21\x23-\x5B\x5D-\x7E]+