MonoCloud Management SDK
    Preparing search index...

    Interface CreateApiResourceRequest

    Create API Resource Request: Creates a protected backend or service.

    CreateApiResourceRequest

    interface CreateApiResourceRequest {
        access_token_lifetime?: number;
        access_token_type?: AccessTokenTypes;
        allow_multi_audience?: boolean;
        allow_user_info_access?: boolean;
        audience: string;
        auto_generate_secret?: 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? audience auto_generate_secret? 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.

    CreateApiResourceRequest

    access_token_type?: AccessTokenTypes

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

    CreateApiResourceRequest

    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.

    CreateApiResourceRequest

    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.

    CreateApiResourceRequest

    audience: string

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

    CreateApiResourceRequest

    auto_generate_secret?: boolean

    Automatically generates a secure secret when the API resource is created. This secret is used by the resource to authenticate when performing token introspection.

    ScaleX subscription required to generate API secrets.

    CreateApiResourceRequest

    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.

    CreateApiResourceRequest

    description?: string | null

    Description that explains the purpose of the resource.

    CreateApiResourceRequest

    display_name?: string | null

    Human-readable display name for the resource.

    CreateApiResourceRequest

    enabled?: boolean

    Indicates whether the resource is enabled.

    CreateApiResourceRequest

    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.

    CreateApiResourceRequest

    user_claims?: string[]

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

    CreateApiResourceRequest

    Settings

    On This Page

    Properties