Create an API scope
Creates a new API scope for the specified API resource. An API scope represents a permission that clients may request and that determines the claims and access level included in issued access tokens.
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>
The unique identifier of the API resource.
Request Body
application/json
The request payload used to create an API scope.
TypeScript Definitions
Use the request body type in TypeScript.
Create API Scope Request: Creates a permission scope for an API resource.
Response Headers
201
Returns the location header
uriResponse Body
application/json
The API scope was created successfully
TypeScript Definitions
Use the response body type in TypeScript.
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.
Errors
curl -X POST "https://your-domain.us.monocloud.com/api/resources/api_resources/n8TniSuy4WN9ROJYNwir6/scopes" \ -H "X-API-KEY: <token>" \ -H "Content-Type: application/json" \ -d '{ "name": "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": [ "string" ]}