MonoCloud Authentication SDK
    Preparing search index...

    Interface MonoCloudBackendNodeClientOptions

    Configuration options for the MonoCloudBackendNodeClient.

    Configuration values can be provided using either:

    • Constructor options - passed when creating the client instance.
    • Environment variables - using MONOCLOUD_BACKEND_* variables.

    When both are provided, constructor options override environment variables.

    Environment Variable Description
    MONOCLOUD_BACKEND_TENANT_DOMAIN The domain of your MonoCloud tenant (for example, https://your-tenant.us.monocloud.com).
    MONOCLOUD_BACKEND_AUDIENCE The expected audience for access token validation (for example, https://api.example.com).
    Environment Variable Description
    MONOCLOUD_BACKEND_CLIENT_ID Unique identifier for your application/client.
    MONOCLOUD_BACKEND_CLIENT_SECRET Application/client secret used for authentication. When clientAuthMethod is private_key_jwt, provide the private key JWK as a JSON string (it is parsed automatically).
    MONOCLOUD_BACKEND_CLIENT_AUTH_METHOD Client authentication method.
    Environment Variable Description
    MONOCLOUD_BACKEND_TRUST_STORE_ID Identifier of the trust store whose mTLS endpoint aliases (mtls_additional_endpoint_aliases) should be used when authenticating with a mutual-TLS client authentication method. When omitted, the default mtls_endpoint_aliases are used.
    Environment Variable Description
    MONOCLOUD_BACKEND_CLOCK_SKEW Allowed clock drift (in seconds) when validating token timestamps.
    MONOCLOUD_BACKEND_CLOCK_TOLERANCE Additional time tolerance (in seconds) for time-based claim validation.
    MONOCLOUD_BACKEND_INTROSPECT_JWT_TOKENS When true, JWT tokens are introspected at the server instead of being validated locally.
    MONOCLOUD_BACKEND_VALIDATE_CERTIFICATE_BINDING Controls certificate binding validation for access tokens.
    MONOCLOUD_BACKEND_RESPONSE_TIMEOUT Maximum time (in milliseconds) to wait for responses from the MonoCloud authorization server.
    Environment Variable Description
    MONOCLOUD_BACKEND_GROUPS_CLAIM The claim name in the token that contains group memberships.
    MONOCLOUD_BACKEND_GROUPS_MATCH_ALL When true, requires the token to contain all specified groups.
    Environment Variable Description
    MONOCLOUD_BACKEND_JWKS_CACHE_DURATION Duration (in seconds) to cache the JSON Web Key Set (JWKS) used to verify tokens.
    MONOCLOUD_BACKEND_METADATA_CACHE_DURATION Duration (in seconds) to cache the OpenID Connect discovery metadata.
    MONOCLOUD_BACKEND_INTROSPECTION_CACHE_DURATION Duration (in seconds) to cache token introspection results.
    interface MonoCloudBackendNodeClientOptions {
        audience: string;
        cache?: IIntrospectionCache;
        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;
        introspectionCacheDuration?: number;
        introspectJwtTokens?: boolean;
        jwksCacheDuration?: number;
        jwksResolver?: () => Jwks | Promise<Jwks>;
        metadataCacheDuration?: number;
        metadataResolver?: () => IssuerMetadata | Promise<IssuerMetadata>;
        responseTimeout?: number;
        tenantDomain: string;
        trustStoreId?: string;
        validateCertificateBinding?: CertificateBindingValidation;
    }

    Hierarchy

    Index
    audience cache? clientAuthMethod? clientId? clientSecret? clockSkew? clockTolerance? fetcher? groupOptions? introspectionCacheDuration? introspectJwtTokens? jwksCacheDuration? jwksResolver? metadataCacheDuration? metadataResolver? responseTimeout? tenantDomain trustStoreId? validateCertificateBinding?
    audience: string

    The expected audience URI for access token validation (e.g. https://api.example.com).

    cache?: IIntrospectionCache

    Optional cache for access token introspection results. Only tokens validated via introspection are cached (opaque tokens, and JWTs when introspectJwtTokens is true); locally-validated JWTs are not cached.

    clientAuthMethod?: ClientAuthMethod

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

    '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.

    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.

    clockSkew?: number

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

    0
    clockTolerance?: number

    Additional time tolerance (in seconds) applied when validating time-based claims (exp and nbf) on access tokens.

    60
    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>

    groupOptions?: IsUserInGroupOptions

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

    introspectionCacheDuration?: number

    Duration (in seconds) to cache token introspection results.

    300 (5 minutes)
    introspectJwtTokens?: boolean

    When true, JWT access tokens are introspected instead of locally validated.

    This skips JWT signature/header/payload checks and always uses the introspection endpoint.

    false
    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).

    responseTimeout?: number

    Maximum time (in milliseconds) to wait for responses from the MonoCloud authorization server before the request is aborted.

    10000 (10 seconds)
    tenantDomain: string

    The MonoCloud tenant domain URL (e.g. https://example.monocloud.dev).

    trustStoreId?: string

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

    validateCertificateBinding?: CertificateBindingValidation

    Controls whether access tokens are validated as being bound to the client certificate presented with the request.

    'when_present'

    Settings

    On This Page
    audiencecacheclientAuthMethodclientIdclientSecretclockSkewclockTolerancefetchergroupOptionsintrospectionCacheDurationintrospectJwtTokensjwksCacheDurationjwksResolvermetadataCacheDurationmetadataResolverresponseTimeouttenantDomaintrustStoreIdvalidateCertificateBinding