MonoCloud Management SDK
    Preparing search index...

    Interface ApiResource

    API Resource Response: Represents a protected API resource and its access-token issuance configuration.

    ApiResource

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

    Properties

    access_token_lifetime access_token_type allow_multi_audience allow_user_info_access audience bind_tokens_to_session creation_time description? display_name? enabled id include_jwt_id last_updated 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.

    ApiResource

    access_token_type: AccessTokenTypes

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

    ApiResource

    allow_multi_audience: boolean

    Default value for whether access tokens issued for this API resource may carry additional audiences beyond this resource. Used when no matching API access policy provides an override.

    ScaleX subscription required to allow multi-audience tokens.

    ApiResource

    allow_user_info_access: boolean

    Default value for whether access tokens issued for this API resource may include identity scopes, allowing them to be used with identity-related endpoints such as UserInfo. Used when no matching API access policy provides an override.

    ScaleX subscription required to allow UserInfo access.

    ApiResource

    audience: string

    Audience value that will be included in issued access tokens for this API resource.

    ApiResource

    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.

    ApiResource

    creation_time: number

    Specifies the creation time of the resource (in Epoch).

    ApiResource

    description?: string | null

    Description that explains the purpose of the resource.

    ApiResource

    display_name?: string | null

    Human-readable display name for the resource.

    ApiResource

    enabled: boolean

    Indicates whether the resource is enabled.

    ApiResource

    id: string

    The unique identifier of the resource.

    ApiResource

    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.

    ApiResource

    last_updated: number

    Specifies the last update time of the resource (in Epoch).

    ApiResource

    user_claims: string[]

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

    ApiResource

    Settings

    On This Page

    Properties