Skip to main content

ICognitoOpenIDConnectTokenRequest

Interface in AWS.CognitoOIDC

Interface for Token requests.

Ancestors​

Properties​

ClientId​

property ClientId: string

Specify the ID of the app client in your user pool.

ClientSecret​

property ClientSecret: string

Specify the client secret for the app client.

Required if the app client has a client secret.

Code​

property Code: string

Specify an authorization code.

Required if GrantType is authorization_code.

CodeVerifier​

property CodeVerifier: string

Specify the proof key.

Required if GrantType is authorization_code and the authorization code was requested with PKCE.

GrantType​

property GrantType: string

Specify the grant type.

Valid values:

  • authorization_code </description> <description> client_credentials </description> <description> refresh_token

Scope​

property Scope: string

Specify the scope(s).

Can be a combination of any custom scopes associated with an app client. The scopes specified must be activated for the app client or it will be ignored. When not specified, the authentication server uses all custom scopes associated with the client. Only used if the GrantType is client_credentials.

RedirectUri​

property RedirectUri: string

Specify the RedirectUri that was used to get the authorization code.

Must be the same URI used to get the authorization code. Only used if the GrantType is authorization_code.

RefreshToken​

property RefreshToken: string

Specify a refresh token to regenerate a new access ID and tokens.