Skip to main content

ISSOOIDCCreateTokenRequest

Interface in AWS.SSOOIDC

Interface for CreateToken requests.

Ancestors

Properties

clientId

property clientId: string

Specify the unique identifier for each client.

This value should be the persisted value returned from RegisterClient.

clientSecret

property clientSecret: string

Specify the client secret generated for the client.

This value should be the persisted value returned from RegisterClient.

code

property code: string

Specify the authorization code received from the authorization service.

codeVerifier

property codeVerifier: string

A value generated by the client and presented to validate the original code challenge value the client passed at authorization time.

Only used when calling this API for the Device code grant type.

deviceCode

property deviceCode: string

Specify the short-term code used to identify this authentication attempt.

Only used when using the device code grant type. This should come from an in-memory reference to the result of StartDeviceAuthorization.

grantType

property grantType: string

Specify the grant type.

Supports grant types:

  • authorization_code
  • refresh_token
  • device code For device code requests, specify the value: urn:ietf:params:oauth:grant-type:device_code.

redirectUri

property redirectUri: string

Specify the location of the application that will receive the authorization code.

refreshToken

property refreshToken: string

Specify a refresh token.

scope

property scope: TList<string>

Specify a list of scope that is defined by the client.

Upon authorization, this list is used to restrict permissions when granting an access token.

Methods

AddScope

function AddScope(const AScope: string): NativeInt;

Add scope to scope.

Parameters

NameDescription
AScopeSpecify a scope defined by the client.

Returns

Returns the index of the scope added to scope.