pl-api
    Preparing search index...

    Interface GetTokenParams

    interface GetTokenParams {
        client_id: string;
        client_secret: string;
        code?: string;
        grant_type: string;
        password?: string;
        redirect_uri: string;
        scope?: string;
        username?: string;
    }
    Index

    Properties

    client_id client_secret code? grant_type password? redirect_uri scope? username?

    Properties

    client_id: string

    String. The client ID, obtained during app registration.

    client_secret: string

    String. The client secret, obtained during app registration.

    code?: string

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

    grant_type: string

    String. 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.

    password?: string
    redirect_uri: string

    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.

    scope?: string

    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.

    username?: string

    Settings

    Member Visibility

    On This Page

    Properties