List API resources

GET

/resources/api_resources

Retrieves a paginated list of API resources. Optional query parameters allow searching, filtering, and sorting the results.

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>

Query Parameters

page?integer

The page number to retrieve.

Formatint32

Range1 <= value

Default1

size?integer

The number of resources to return per page.

Formatint32

Range1 <= value <= 50

Default10

filter?string

Optional Lucene-style filter expression used to search by attributes.

sort?string

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

x-Pagination?object

Returns the x-Pagination header

page_size*integer

Number of items returned per page.

Formatint32

current_page*integer

The current page number.

Formatint32

total_count*integer

Total number of items available.

Formatint32

has_previous*boolean

Indicates whether a previous page exists.

has_next*boolean

Indicates whether a next page exists.

Response Body

200

application/json

The API resources were retrieved successfully

TypeScript Definitions

Use the response body type in TypeScript.

Returns an array. Each item has the fields below.

API Resource Response: Represents a protected API resource and its access-token issuance configuration.

id*string

The unique identifier of the resource.

enabled*boolean

Indicates whether the resource is enabled.

display_name?|

Human-readable display name for the resource.

description?|

Description that explains the purpose of the resource.

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

audience*string

Audience value that will be included in issued access tokens for this API resource.

allow_multi_audience*boolean

Default value for whether access tokens issued for this API resource may carry additional audiences beyond this resource. Used when no matching API access policy provides an override.

ScaleX subscription required to allow multi-audience tokens.

allow_user_info_access*boolean

Default value for whether access tokens issued for this API resource may include identity scopes, allowing them to be used with identity-related endpoints such as UserInfo. Used when no matching API access policy provides an override.

ScaleX subscription required to allow UserInfo access.

access_token_type*AccessTokenTypes

Default access token type for this API resource. Used when no matching API access policy provides an override.

values

jwt
A self-contained JWT access token.
reference
An opaque reference token stored and validated server-side.

access_token_lifetime*integer

Default access token lifetime (in seconds) for this API resource. Used when no matching API access policy provides an override.

Formatint32

bind_tokens_to_session*boolean

Default value for whether access tokens issued for this API resource are bound to the user session, causing them to be revoked when the session ends. Used when no matching API access policy provides an override.

ScaleX subscription required to use session binding.

include_jwt_id*boolean

Determines whether access tokens issued for this API resource include a unique token identifier (jti).

Recommended for auditing, correlation, and replay-detection.

user_claims*array<string>

List of user claim types that will be embedded into access tokens issued for this API resource.

Errors

401Unauthorized

403Forbidden

curl -X GET "https://your-domain.us.monocloud.com/api/resources/api_resources?page=1&size=10&filter=api&sort=creation_time%3A1" \  -H "X-API-KEY: <token>"

[  {    "id": "string",    "enabled": true,    "display_name": null,    "description": null,    "creation_time": 0,    "last_updated": 0,    "audience": "string",    "allow_multi_audience": true,    "allow_user_info_access": true,    "access_token_type": "jwt",    "access_token_lifetime": 0,    "bind_tokens_to_session": true,    "include_jwt_id": true,    "user_claims": [      "string"    ]  }]

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response HeadersCopy Anchor Link

Response BodyCopy Anchor Link

ErrorsCopy Anchor Link

Authorization

Query Parameters

Response Headers

Response Body

Errors