InterfaceCreateTokenWithPasswordParams

interface CreateTokenWithPasswordParams {
    clientId: string;
    clientSecret: string;
    grantType: "password";
    password: string;
    redirectUri: string;
    scope?: null | string;
    username: string;
}

Hierarchy

  • BaseCreateTokenParams<"password">
    • CreateTokenWithPasswordParams

Properties

clientId clientSecret grantType password redirectUri scope? username

Properties

ReadonlyclientId

clientId: string

The client ID, obtained during app registration.

ReadonlyclientSecret

clientSecret: string

The client secret, obtained during app registration.

ReadonlygrantType

grantType

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.

Readonlypassword

password: string

ReadonlyredirectUri

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 Readonlyscope

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.

Readonlyusername

username: string

Settings

Member Visibility

On This Page

Properties