MonoCloud Authentication SDK
    Preparing search index...

    Interface MonoCloudOidcBackendClientOptions

    Configuration options used to initialize the MonoCloudOidcBackendClient.

    interface MonoCloudOidcBackendClientOptions {
        clientAuthMethod?: ClientAuthMethod;
        clientId?: string;
        clientSecret?: string | Jwk;
        clockSkew?: number;
        clockTolerance?: number;
        fetcher?: {
            (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
            (input: string | URL | Request, init?: RequestInit): Promise<Response>;
        };
        groupOptions?: IsUserInGroupOptions;
        jwksCacheDuration?: number;
        metadataCacheDuration?: number;
    }

    Hierarchy

    Index

    Properties

    clientAuthMethod?: ClientAuthMethod

    Client authentication method used when communicating with the token endpoint.

    'client_secret_basic'
    
    clientId?: string

    Client identifier of the application registered in MonoCloud.

    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.

    clockSkew?: number

    Number of seconds to adjust the current time to account for clock differences.

    0
    
    clockTolerance?: number

    Additional time tolerance in seconds for time-based claim validation.

    300
    
    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>
      • Parameters

        • input: URL | RequestInfo
        • Optionalinit: RequestInit

        Returns Promise<Response>

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

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

        Returns Promise<Response>

    groupOptions?: IsUserInGroupOptions

    Options for group membership validation applied to all token validations performed by this client.

    jwksCacheDuration?: number

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

    300
    
    metadataCacheDuration?: number

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

    300