List API scopes
Retrieves a paginated list of API scopes for the specified API resource. Optional query parameters allow searching, filtering, and sorting the results.
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.
The page number to retrieve.
int321 <= value1The number of resources to return per page.
int321 <= value <= 5010Optional Lucene-style filter expression used to search by attributes.
Sort expression in the format field:direction, where direction is 1 for ascending or -1 for descending. Supported fields include - name, display_name, and creation_time
Response Headers
200
Returns the x-Pagination header
Number of items returned per page.
int32The current page number.
int32Total number of items available.
int32Indicates whether a previous page exists.
Indicates whether a next page exists.
Response Body
application/json
The API scopes were retrieved successfully
TypeScript Definitions
Use the response body type in TypeScript.
Returns an array. Each item has the fields below.
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 GET "https://your-domain.us.monocloud.com/api/resources/api_resources/n8TniSuy4WN9ROJYNwir6/scopes?page=1&size=10&filter=api&sort=creation_time%3A1" \ -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": [ "string" ] }]Delete an API resource secret DELETE
Permanently deletes the specified API resource secret.
Create an API scope POST
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.