MonoCloud Management SDK
    Preparing search index...

    API Scope Response: Represents a permissioned scope that defines the level of access a client may request and that can be embedded into access tokens.

    ApiScope

    interface ApiScope {
        creation_time: number;
        description?: string | null;
        display_name?: string | null;
        emphasize: boolean;
        id: string;
        is_default: boolean;
        last_updated: number;
        name: string;
        required: boolean;
        show_in_discovery_document: boolean;
        user_claims: string[];
    }
    Index

    Properties

    creation_time: number

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

    ApiScope

    description?: string | null

    Description that explains the purpose of the resource.

    ApiScope

    display_name?: string | null

    Human-readable display name for the resource.

    ApiScope

    emphasize: boolean

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

    ApiScope

    id: string

    The unique identifier of the resource.

    ApiScope

    is_default: boolean

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

    ApiScope

    last_updated: number

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

    ApiScope

    name: string

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

    ApiScope

    required: boolean

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

    ApiScope

    show_in_discovery_document: boolean

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

    ApiScope

    user_claims: string[]

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

    ApiScope