Interface CreateTokenWithAuthorizationCodeParams

interface CreateTokenWithAuthorizationCodeParams {
    clientId: string;
    clientSecret: string;
    code: string;
    grantType: "authorization_code";
    redirectUri: string;
    scope?: null | string;
}

Hierarchy

  • BaseCreateTokenParams<"authorization_code">
    • CreateTokenWithAuthorizationCodeParams

Properties

clientId clientSecret code grantType redirectUri scope?

Properties

Readonly clientId

clientId: string

The client ID, obtained during app registration.

Readonly clientSecret

clientSecret: string

The client secret, obtained during app registration.

Readonly code

code: string

A user authorization code, obtained via GET /oauth/authorize.

Readonly grantType

grantType: "authorization_code"

Set equal to authorization_code if code is provided in order to gain user-level access. Otherwise, set equal to client_credentials to obtain app-level access only.

Readonly redirectUri

redirectUri: string

Set a URI to redirect the user to. If this parameter is set to urn:ietf:wg:oauth:2.0:oob then the token will be shown instead. Must match one of the redirect_uris declared during app registration.

Optional Readonly scope

scope?: null | string

List of requested OAuth scopes, separated by spaces (or by pluses, if using query parameters). If code was provided, then this must be equal to the scope requested from the user. Otherwise, it must be a subset of scopes declared during app registration. If not provided, defaults to read.

Settings

Member Visibility

Theme

On This Page

clientIdclientSecretcodegrantTyperedirectUriscope