/api/apis/{api_server_id}AuthenticatedUpdate an API server's dynamic-client policy
Updates whether dynamically registered clients may request tokens for this API server as an RFC 8707 resource, and how a resource URL is matched against its registered domains. Nothing else about an API server is updatable here. Hardcoded API servers cannot be changed.
patch_api_apis_api_server_idAPI serversAuthentication & permissionsAuthenticated
Any authenticated user
- Accepted credentials
- Auth server session (refresh token cookie)
cookie "refresh_token_<auth_server_app_id>" - Access token (cookie)
cookie "access_token_<auth_server_app_id>" - Access token (Bearer)
Authorization: Bearer <JWT>
- Auth server session (refresh token cookie)
- Who may call
- Any authenticated user
- Notes
- Organization owners/admins of the owning organization, the owning user, or platform administrators.
Path parameters
| Name | Type | Description |
|---|---|---|
| api_server_id* | string | API server id |
Request body
Required
| Property | Type | Description |
|---|---|---|
| allow_dynamic_clients | boolean | Whether clients registered through RFC 7591 dynamic client registration may obtain access tokens for this API server (as an RFC 8707 |
| resource_url_match_mode | "exact" | "prefix" | Whether an RFC 8707 |
Responses
| Property | Type | Description |
|---|---|---|
| success* | true | |
| api_server* | ApiServerDefinition | An API server (resource server) registration: identity, listing visibility, ownership (platform / organization / user) and dynamic-client policy. |
| api_server_id* | string | minLength: 2maxLength: 64pattern: ^[a-z0-9_-]*$ |
| api_server_name* | string | maxLength: 64 |
| api_server_description* | string | maxLength: 512 |
| created_at* | number | minimum: 0 |
| public* | boolean | |
| hardcoded* | boolean | |
| owner_type | "platform" | "organization" | "user" | "dynamic-client-registration" | |
| owner_organization_id | string | null | null | |
| owner_uid | string (uuid) | null (uuid) | null | |
| created_by | string (uuid) | null (uuid) | null | |
| allow_dynamic_clients | boolean | |
| resource_url_match_mode | "exact" | "prefix" |
Example request
curl -X PATCH 'https://auth.schemavaults.com/api/apis/<api_server_id>' \
-b 'refresh_token_<auth_server_app_id>=<value>' \
-H 'Content-Type: application/json' \
-d '{
"allow_dynamic_clients": true,
"resource_url_match_mode": "exact"
}'