IFClite TypeScript API
    Preparing search index...

    Interface AuthorizationCodeGrantOptions

    interface AuthorizationCodeGrantOptions {
        clientId?: string;
        clientSecret?: string;
        code: string;
        codeVerifier?: string;
        errorNamespace?: string;
        fetchFn?: FetchLike;
        redirectUri: string;
        tokenUrl: string;
    }

    Hierarchy

    • TokenRequestOptions
      • AuthorizationCodeGrantOptions
    Index
    clientId? clientSecret? code codeVerifier? errorNamespace? fetchFn? redirectUri tokenUrl
    clientId?: string

    Public client id, when the server requires one.

    clientSecret?: string

    Client secret; only for servers whose token endpoint demands it.

    code: string

    The code returned to the redirect URI by the authorization server.

    codeVerifier?: string

    PKCE verifier when the authorization request carried a challenge.

    errorNamespace?: string

    Prefix of thrown errors' name (see FoundationApiError); defaults to 'Foundation'.

    fetchFn?: FetchLike
    redirectUri: string

    Must byte-match the redirect_uri sent on the authorization request.

    tokenUrl: string

    OAuth2 token endpoint, from the server's /auth discovery document.

    Settings
    Member Visibility

    On This Page
    Properties