MonoCloud Management SDK
    Preparing search index...

    Interface CreateApiResourceRequest

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

    CreateApiResourceRequest

    interface CreateApiResourceRequest {
        audience: string;
        auto_generate_secret?: boolean;
        description?: string | null;
        display_name?: string | null;
        enable_identity_access?: boolean;
        enabled?: boolean;
        require_exclusive_token?: boolean;
        user_claims?: string[];
    }
    Index

    Properties

    audience auto_generate_secret? description? display_name? enable_identity_access? enabled? require_exclusive_token? user_claims?

    Properties

    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

    description?: string | null

    Description that explains the purpose of the resource.

    CreateApiResourceRequest

    display_name?: string | null

    Human-readable display name for the resource.

    CreateApiResourceRequest

    enable_identity_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 use resource isolation.

    CreateApiResourceRequest

    enabled?: boolean

    Indicates whether the resource is enabled.

    CreateApiResourceRequest

    require_exclusive_token?: boolean

    Specifies whether access tokens issued for this resource must be exclusive and not shared with other API resources.

    ScaleX subscription required to use resource isolation.

    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