MonoCloud Authentication SDK
    Preparing search index...

    Interface AuthenticateOptions

    Options used for authenticating a user with authorization code

    interface AuthenticateOptions {
        codeVerifier?: string;
        fetchUserInfo?: boolean;
        filteredIdTokenClaims?: string[];
        idTokenClockSkew?: number;
        idTokenClockTolerance?: number;
        idTokenMaxAge?: number;
        idTokenNonce?: string;
        jwks?: Jwks;
        onSessionCreating?: OnSessionCreating;
        validateIdToken?: boolean;
    }
    Index

    Properties

    codeVerifier? fetchUserInfo? filteredIdTokenClaims? idTokenClockSkew? idTokenClockTolerance? idTokenMaxAge? idTokenNonce? jwks? onSessionCreating? validateIdToken?

    Properties

    codeVerifier?: string

    The PKCE Code verifier used for authentication

    fetchUserInfo?: boolean

    When enabled, the userinfo is fetched and populated into the user object.

    false
    filteredIdTokenClaims?: string[]

    List of ID token claims to remove.

    idTokenClockSkew?: number

    Used to adjust the current time to align with the authorization server time

    idTokenClockTolerance?: number

    Allowed clock tolerance when checking date-time claims

    idTokenMaxAge?: number

    Allowed max age in seconds

    idTokenNonce?: string

    Nonce to be validated against the claims from the ID token

    jwks?: Jwks

    Jwks to validate the ID token with. JWKS is fetched from the authorization server if jwks is not provided.

    onSessionCreating?: OnSessionCreating

    A callback function invoked before creating or updating the user session.

    validateIdToken?: boolean

    Whether to validate the ID token or not.

    true

    Settings

    Member Visibility

    On This Page

    Properties