Create a scope
Creates a new identity scope that defines a permission clients can request to receive specific user claims.
API-KeyX-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>
Request Body
application/json
The request payload used to create a new scope.
TypeScript Definitions
Use the request body type in TypeScript.
Create Scope Request: Creates an identity scope that defines a permission for accessing user claims.
Response Headers
201
Returns the location header
uriResponse Body
application/json
The scope was created 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.
Errors
curl -X POST "https://your-domain.us.monocloud.com/api/resources/scopes" \ -H "X-API-KEY: <token>" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "user_claims": [ { "claim": "string" } ] }'{ "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 } ]}