pl-api
    Preparing search index...

    Interface OauthAuthorizeParams

    interface OauthAuthorizeParams {
        client_id: string;
        force_login?: boolean;
        lang?: string;
        redirect_uri: string;
        response_type: string;
        scope?: string;
    }
    Index

    Properties

    client_id force_login? lang? redirect_uri response_type scope?

    Properties

    client_id: string

    String. The client ID, obtained during app registration.

    force_login?: boolean

    Boolean. Forces the user to re-login, which is necessary for authorizing with multiple accounts from the same instance.

    lang?: string

    String. The ISO 639-1 two-letter language code to use while rendering the authorization form.

    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 authorization code will be shown instead. Must match one of the redirect_uris declared during app registration.

    response_type: string

    String. Should be set equal to code.

    scope?: string

    String. List of requested OAuth scopes, separated by spaces (or by pluses, if using query parameters). Must be a subset of scopes declared during app registration. If not provided, defaults to read.

    Settings

    Member Visibility

    On This Page

    Properties