MonoCloud Authentication SDK
    Preparing search index...

    Interface MonoCloudOidcClientOptions

    Configuration options used to initialize the MonoCloudOidcClient.

    interface MonoCloudOidcClientOptions {
        clientAuthMethod?: ClientAuthMethod;
        clientSecret?: string | Jwk;
        fetcher?: {
            (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
            (input: string | URL | Request, init?: RequestInit): Promise<Response>;
        };
        idTokenSigningAlgorithm?: SecurityAlgorithms;
        jwksCacheDuration?: number;
        jwksResolver?: () => Jwks | Promise<Jwks>;
        metadataCacheDuration?: number;
        metadataResolver?: () => IssuerMetadata | Promise<IssuerMetadata>;
        trustStoreId?: string;
    }

    Hierarchy

    Index
    clientAuthMethod? clientSecret? fetcher? idTokenSigningAlgorithm? jwksCacheDuration? jwksResolver? metadataCacheDuration? metadataResolver? trustStoreId?
    clientAuthMethod?: ClientAuthMethod

    Client authentication method used when the client authenticates to the authorization server.

    'client_secret_basic'
    clientSecret?: string | Jwk

    Client secret or key material used for client authentication.

    When clientAuthMethod is client_secret_jwt and a plain-text secret is provided, the default signing algorithm is HS256.

    To use a different algorithm, provide a symmetric JSON Web Key (JWK) (kty: "oct") with the desired algorithm specified in its alg property.

    When clientAuthMethod is spiffe_jwt, provide the SPIFFE JWT-SVID (obtained from the SPIFFE Workload API) as the plain-text string; it is sent as the client_assertion.

    fetcher?: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    }

    Optional custom fetch implementation used for network requests.

    Type Declaration

      • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: URL | RequestInfo
        • Optionalinit: RequestInit

        Returns Promise<Response>

      • (input: string | URL | Request, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: string | URL | Request
        • Optionalinit: RequestInit

        Returns Promise<Response>

    idTokenSigningAlgorithm?: SecurityAlgorithms

    Expected signing algorithm for validating ID tokens.

    'RS256'
    jwksCacheDuration?: number

    Duration (in seconds) to cache the JSON Web Key Set (JWKS) retrieved from the authorization server.

    300
    jwksResolver?: () => Jwks | Promise<Jwks>

    Optional custom resolver for the JSON Web Key Set (JWKS).

    metadataCacheDuration?: number

    Duration (in seconds) to cache OpenID Connect discovery metadata.

    300
    metadataResolver?: () => IssuerMetadata | Promise<IssuerMetadata>

    Optional custom resolver for the issuer metadata (OpenID Connect discovery document).

    trustStoreId?: string

    Identifier of the trust store whose mTLS endpoint aliases should be used when authenticating with a mutual-TLS client authentication method.

    Settings

    On This Page
    Properties