Auth0 Node.js SDK - v5.1.0
    Preparing search index...

    Interface PasswordGrantRequest

    interface PasswordGrantRequest {
        client_id?: string;
        client_secret?: string;
        client_assertion?: string;
        client_assertion_type?: "urn:ietf:params:oauth:client-assertion-type:jwt-bearer";
        audience?: string;
        username: string;
        password: string;
        scope?: string;
        realm?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    client_id? client_secret? client_assertion? client_assertion_type? audience? username password scope? realm?

    Properties

    client_id?: string

    Specify this to override the parent class's clientId

    client_secret?: string

    Specify this to override the parent class's clientSecret

    client_assertion?: string

    Specify this to provide your own client assertion JWT rather than the class creating one for you from the clientAssertionSigningKey.

    client_assertion_type?: "urn:ietf:params:oauth:client-assertion-type:jwt-bearer"

    If you provide your own client_assertion you should also provide the client_assertion_type.

    audience?: string

    The unique identifier of the target API you want to access.

    username: string

    Resource Owner's identifier, such as a username or email address.

    password: string

    Resource Owner's secret.

    scope?: string

    String value of the different scopes the application is asking for. Multiple scopes are separated with whitespace.

    realm?: string

    String value of the realm the user belongs. Set this if you want to add realm support at this grant. For more information on what realms are refer to https://auth0.com/docs/get-started/authentication-and-authorization-flow/resource-owner-password-flow#realm-support.

    Settings

    Member Visibility

    On This Page

    Properties