Skip to main content
Latest
namespace TokenCreateResponse
Re-export
import { TokenCreateResponse } from "https://deno.land/x/authlete_deno@v1.2.10/mod.ts";

Enums

The next action that the service implementation should take.

class TokenCreateResponse
extends ApiResponse
Re-export
import { TokenCreateResponse } from "https://deno.land/x/authlete_deno@v1.2.10/mod.ts";

Response from Authlete /auth/token/create API.

Properties

optional
accessToken: string

The newly issued access token.

The next action that the service implementation should take.

optional
authorizationDetails: AuthzDetails

The authorization details associated with the access token.

clientId: number

The client ID.

expiresAt: number

The date at which the newly issued access token will expire. The value is expressed in milliseconds since Unix epoch (1970-01-01).

expiresIn: number

The duration of the newly issued access token in seconds.

forExternalAttachment: boolean

The flag which indicates whether the access token is for an external attachment.

For more details, see OpenID Connect for Identity Assurance 1.0, External Attachments.

grantType: GrantType

The grant type for a newly created access token.

optional
jwtAccessToken: string

The newly issued access token in JWT format.

If the authorization server is configured to issue JWT-based access tokens (= if Service.accessTokenSignAlg is a non-null value), a JWT-based access token is issued along with the original random-string one.

optional
properties: Property[]

The properties associated with the access token.

optional
refreshToken: string

The newly issued Refresh token. This is null when the grant type is either GrantType.IMPLICIT IMPLICIT or GrantType.CLIENT_CREDENTIALS CLIENT_CREDENTIALS.

optional
scopes: string[]

The scopes covered by the access token.

optional
subject: string

The subject (= unique identifier) of the user associated with the newly issued access token. This value is null when the grant type obtained by grantType is GrantType.CLIENT_CREDENTIALS.

optional
tokenId: string

The unique token identifier.

optional
tokenType: string

The token type of the access token. For example, "Bearer".