Retrieve a scope

GET

/resources/scopes/{scope_id}

Retrieves detailed information for the specified identity scope.

Authorization

API-Key

headerX-API-KEY<token>

MonoCloud APIs require authentication with an API key. Retrieve your key from the Tenant Settings section of the MonoCloud dashboard and include it in the request header as: X-API-Key: <your_api_key>

Path Parameters

scope_id*string

The unique identifier of the scope.

Response Body

200

application/json

The scope was retrieved successfully

TypeScript Definitions

Use the response body type in TypeScript.

Scope Response: Represents a permission that can be requested by clients and evaluated during authorization.

id*string

The unique identifier of the resource.

display_name?|

Human-readable display name for the resource.

description?|

Description that explains the purpose of the resource.

show_in_discovery_document*boolean

Indicates whether this resource is advertised via the discovery document.

creation_time*integer

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

Formatdate-time

last_updated*integer

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

Formatdate-time

name*string

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

required*boolean

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

emphasize*boolean

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

is_default*boolean

Indicates whether this is a built-in identity scope provided by the platform.

user_claims*array<>

List of user claim types that will be embedded into identity tokens and/or returned from the UserInfo endpoint when this scope is granted.

Errors

401Unauthorized

403Forbidden

curl -X GET "https://your-domain.us.monocloud.com/api/resources/scopes/tQi5Nu2sg7TVB727UfHPT" \  -H "X-API-KEY: <token>"

{  "id": "string",  "display_name": null,  "description": null,  "show_in_discovery_document": true,  "creation_time": 0,  "last_updated": 0,  "name": "string",  "required": true,  "emphasize": true,  "is_default": true,  "user_claims": [    {      "claim": "string",      "include_in_identity_token": true,      "include_in_user_info": true    }  ]}

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

ErrorsCopy Anchor Link

404Not Found

422Unprocessable Entity

Authorization

Path Parameters

Response Body

Errors