Member Junction
    Preparing search index...

    Interface OAuth2TokenRequest

    Inputs needed to mint/refresh an OAuth2 access token.

    interface OAuth2TokenRequest {
        ClientId: string;
        ClientSecret: string;
        ExtraParams?: Record<string, string>;
        Password?: string;
        RefreshToken?: string;
        ScopeParam?: string;
        Scopes?: string;
        TimeoutMs?: number;
        TokenURL: string;
        UseBasicAuth?: boolean;
        Username?: string;
        UsernameParam?: string;
    }
    Index

    Properties

    ClientId ClientSecret ExtraParams? Password? RefreshToken? ScopeParam? Scopes? TimeoutMs? TokenURL UseBasicAuth? Username? UsernameParam?

    Properties

    ClientId: string

    OAuth2 client identifier.

    ClientSecret: string

    OAuth2 client secret.

    ExtraParams?: Record<string, string>

    Extra application/x-www-form-urlencoded parameters appended to the grant body for vendors whose token endpoint requires non-standard inputs — e.g. Auth0's audience on a client_credentials grant, or a vendor-specific resource/tenant param. Applies to every grant type; standard params (grant_type, client_id/secret, scope, refresh_token, username, password) take precedence and are never overwritten by this map.

    Password?: string

    Password — required for the password grant.

    RefreshToken?: string

    Refresh token — required for the refresh_token grant.

    ScopeParam?: string

    Parameter name carrying the scopes. Defaults to scope.

    Scopes?: string

    Space- or comma-delimited scopes (sent as the scopes/scope param).

    TimeoutMs?: number

    Request timeout in ms. Default 30000.

    TokenURL: string

    Absolute token endpoint URL (e.g. https://tenant.example.com/oauth/token).

    UseBasicAuth?: boolean

    Send client_id/secret as HTTP Basic instead of in the form body. Default false.

    Username?: string

    Username — required for the password grant.

    UsernameParam?: string

    Parameter name carrying the username in a password grant. Defaults to username (RFC 6749 §4.3). Some Doorkeeper/WineBouncer deployments (e.g. Hivebrite) name it admin_email; set this to that key when the vendor diverges from the spec name.

    Settings

    Member Visibility

    On This Page

    Properties