PAOIDCClient
    Preparing search index...

    Interface AuthRequestOptions

    Options used when creating an authorization request. Most fields map directly to OpenID Connect or OAuth2 parameters.

    https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest

    interface AuthRequestOptions {
        acr_values?: string;
        audience?: string;
        claims?: Record<string, any>;
        claims_locales?: string;
        client_id?: string;
        code_challenge?: string;
        code_challenge_method?: string;
        code_verifier?: string;
        display?: string;
        extraParams?: Record<string, any>;
        fragment?: string;
        id_token_hint?: string;
        login_hint?: string;
        nonce?: string;
        prompt?: string;
        redirect_uri?: string;
        registration?: string;
        request_type?: "d" | "p" | "s";
        response_mode?: string;
        response_type?: string;
        scope?: string;
        state?: string;
        ui_locales?: string;
        web_message_target?: string;
        web_message_uri?: string;
    }
    Index

    Properties

    acr_values? audience? claims? claims_locales? client_id? code_challenge? code_challenge_method? code_verifier? display? extraParams? fragment? id_token_hint? login_hint? nonce? prompt? redirect_uri? registration? request_type? response_mode? response_type? scope? state? ui_locales? web_message_target? web_message_uri?

    Properties

    acr_values?: string

    Requested Authentication Context Class Reference values.

    audience?: string

    Audience for which the client is requesting access.

    claims?: Record<string, any>

    Claims parameter requesting specific user attributes.

    claims_locales?: string

    Preferred languages for user claims.

    client_id?: string

    OAuth2 client identifier.

    code_challenge?: string

    PKCE code challenge.

    code_challenge_method?: string

    PKCE code challenge method (typically "S256").

    code_verifier?: string

    PKCE verifier used for exchanging authorization code.

    display?: string

    Display type: page, popup, etc.

    extraParams?: Record<string, any>

    Additional parameters appended to the authorization request.

    fragment?: string

    Optional URI fragment used by web_message or custom response handling.

    id_token_hint?: string

    Id token hint for reauthentication scenarios.

    login_hint?: string

    Optional login hint such as email or username.

    nonce?: string

    Generated nonce for replay protection.

    prompt?: string

    Prompt behavior: none, login, consent, etc.

    redirect_uri?: string

    Redirect URI registered for the client.

    registration?: string

    Client registration parameter (rarely used).

    request_type?: "d" | "p" | "s"

    Internal request type:

    • "s" → silent
    • "p" → popup
    • "d" → standard redirect
    response_mode?: string

    OAuth2/OIDC response mode such as fragment, query, form_post.

    response_type?: string

    OAuth2/OIDC response type such as code, token, id_token.

    scope?: string

    Requested scopes.

    state?: string

    Client-generated state value used for request correlation.

    ui_locales?: string

    Preferred UI locales for login experience.

    web_message_target?: string

    Web Message response target (used in popup/iframe login).

    web_message_uri?: string

    Web Message receiver URL.

    Settings

    Member Visibility

    On This Page

    Properties