CreateTokenRequest

import type { CreateTokenRequest } from "https://aws-api.deno.dev/v0.4/services/ssooidc.ts?docs=full";

interface CreateTokenRequest {

clientId: string;

clientSecret: string;

code?: string | null;

deviceCode?: string | null;

grantType: string;

redirectUri?: string | null;

refreshToken?: string | null;

scope?: string[] | null;

}

§Properties

clientId: string

[src]

The unique identifier string for each client. This value should come from the persisted result of the "RegisterClient" API.

clientSecret: string

[src]

A secret string generated for the client. This value should come from the persisted result of the "RegisterClient" API.

code?: string | null

[src]

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

deviceCode?: string | null

[src]

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 "StartDeviceAuthorization" API.

grantType: string

[src]

Supports grant types for the authorization code, refresh token, and device code request. For device code requests, specify the following value:

urn:ietf:params:oauth:grant-type:_device_code_

For information about how to obtain the device code, see the "StartDeviceAuthorization" topic.

redirectUri?: string | null

[src]

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

refreshToken?: string | null

[src]

Currently, refreshToken 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 IAM Identity Center OIDC API Reference.

The token used to obtain an access token in the event that the access token is invalid or expired.

scope?: string[] | null

[src]

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