MonoCloud Management SDK
    Preparing search index...

    Interface CreateApiScopeRequest

    Create API Scope Request: Creates a permission scope for an API resource.

    CreateApiScopeRequest

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

    Properties

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

    Properties

    description?: string | null

    Description that explains the purpose of the resource.

    CreateApiScopeRequest

    display_name?: string | null

    Human-readable display name for the resource.

    CreateApiScopeRequest

    emphasize?: boolean

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

    CreateApiScopeRequest

    is_default?: boolean

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

    CreateApiScopeRequest

    name: string

    The unique name of the scope. This is the value a client will use for the scope parameter in the authorize request.

    CreateApiScopeRequest

    required?: boolean

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

    CreateApiScopeRequest

    show_in_discovery_document?: boolean

    Indicates whether this API scope is advertised via the discovery document.

    CreateApiScopeRequest

    user_claims?: string[]

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

    CreateApiScopeRequest

    Settings

    On This Page

    Properties