MonoCloud Management SDK
    Preparing search index...

    Interface PatchApiScopeRequest

    Patch API Scope Request: Used to update one or more properties of an existing API scope.

    PatchApiScopeRequest

    interface PatchApiScopeRequest {
        description?: string | null;
        display_name?: string | null;
        emphasize?: boolean;
        is_default?: boolean;
        required?: boolean;
        show_in_discovery_document?: boolean;
        user_claims?: string[];
    }
    Index

    Properties

    description? display_name? emphasize? is_default? required? show_in_discovery_document? user_claims?

    Properties

    description?: string | null

    Description that explains the purpose of the resource.

    PatchApiScopeRequest

    display_name?: string | null

    Human-readable display name for the resource.

    PatchApiScopeRequest

    emphasize?: boolean

    Indicates whether this scope is visually emphasized on the consent screen, typically for sensitive or high-impact permissions.

    PatchApiScopeRequest

    is_default?: boolean

    Specifies whether this scope is automatically included in issued tokens when the scope parameter is omitted.

    PatchApiScopeRequest

    required?: boolean

    Specifies whether the scope is mandatory and cannot be de-selected by the user on the consent screen.

    PatchApiScopeRequest

    show_in_discovery_document?: boolean

    Indicates whether this resource is advertised via the discovery document.

    PatchApiScopeRequest

    user_claims?: string[]

    List of user claim types that will be embedded into access tokens when this scope is granted.

    PatchApiScopeRequest

    Settings

    On This Page

    Properties