Interface AccessTokenForConnectionOptions

Options for retrieving a connection access token.

interface AccessTokenForConnectionOptions {
    connection: string;
    login_hint?: string;
    subject_token_type?: SUBJECT_TOKEN_TYPES;
}

Properties

connection: string

The connection name for while you want to retrieve the access token.

login_hint?: string

An optional login hint to pass to the authorization server.

subject_token_type?: SUBJECT_TOKEN_TYPES

The type of token that is being exchanged.

Uses the SUBJECT_TOKEN_TYPES enum with the following allowed values:

SUBJECT_TYPE_REFRESH_TOKEN: "urn:ietf:params:oauth:token-type:refresh_token"
SUBJECT_TYPE_ACCESS_TOKEN: "urn:ietf:params:oauth:token-type:access_token"

Defaults to SUBJECT_TYPE_REFRESH_TOKEN.