MonoCloud Management SDK
    Preparing search index...

    Interface PatchApiResourceRequest

    Patch API Resource Request: Used to update one or more properties of an existing API resource.

    PatchApiResourceRequest

    interface PatchApiResourceRequest {
        access_token_lifetime?: number;
        access_token_type?: AccessTokenTypes;
        allow_multi_audience?: boolean;
        allow_user_info_access?: boolean;
        bind_tokens_to_session?: boolean;
        description?: string | null;
        display_name?: string | null;
        enabled?: boolean;
        include_jwt_id?: boolean;
        user_claims?: string[];
    }
    Index

    Properties

    access_token_lifetime? access_token_type? allow_multi_audience? allow_user_info_access? bind_tokens_to_session? description? display_name? enabled? include_jwt_id? user_claims?

    Properties

    access_token_lifetime?: number

    Default access token lifetime (in seconds) for this API resource. Used when no matching API access policy provides an override.

    PatchApiResourceRequest

    access_token_type?: AccessTokenTypes

    Default access token type for this API resource. Used when no matching API access policy provides an override.

    ScaleX subscription required to use reference tokens. Reference tokens improve revocation control and reduce exposure risk, but require token introspection by protected resources.

    PatchApiResourceRequest

    allow_multi_audience?: boolean

    Specifies whether access tokens issued for this resource may carry additional audiences beyond this resource.

    ScaleX subscription required to allow multi-audience tokens.

    PatchApiResourceRequest

    allow_user_info_access?: boolean

    Specifies whether access tokens issued for this resource may include identity scopes, allowing them to be used with identity-related endpoints such as UserInfo.

    ScaleX subscription required to allow UserInfo access.

    PatchApiResourceRequest

    bind_tokens_to_session?: boolean

    Default value for whether access tokens issued for this API resource are bound to the user session, causing them to be revoked when the session ends. Used when no matching API access policy provides an override.

    ScaleX subscription required to use session binding.

    PatchApiResourceRequest

    description?: string | null

    Description that explains the purpose of the resource.

    PatchApiResourceRequest

    display_name?: string | null

    Human-readable display name for the resource.

    PatchApiResourceRequest

    enabled?: boolean

    Indicates whether the resource is enabled.

    PatchApiResourceRequest

    include_jwt_id?: boolean

    Determines whether access tokens issued for this API resource include a unique token identifier (jti).

    Recommended for auditing, correlation, and replay-detection.

    PatchApiResourceRequest

    user_claims?: string[]

    List of user claim types that will be embedded into access tokens issued for this API resource.

    PatchApiResourceRequest

    Settings

    On This Page

    Properties