GET
/api/apis/{api_server_id}/scopesAuthenticatedList an API server's scopes
Lists the API scopes the API server defines, oldest first. A client asks for them on an authorization request whose RFC 8707 resource names the API server (GET /api/oidc/authorize?resource=...&scope=...); the requested scopes the API server defines are granted on the access tokens minted for it. Hardcoded API servers define none.
operationId
get_api_apis_api_server_id_scopesAPI 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
- Anyone signed in for a public API server; for a private one, members (any role) of the owning organization, the owning user of a user-owned API server, or platform administrators.
Path parameters
| Name | Type | Description |
|---|---|---|
| api_server_id* | string | API server id |
Responses
application/json
ListApiServerScopesResponse
| Property | Type | Description |
|---|---|---|
| success* | true | |
| list* | ApiServerScope[] | |
| api_server_scope_id* | string (uuid) | |
| api_server_id* | string | minLength: 2maxLength: 64pattern: ^[a-z0-9_-]*$ |
| scope* | string | minLength: 1maxLength: 128pattern: ^[\x21\x23-\x5B\x5D-\x7E]+$ |
| description* | string | maxLength: 256 |
| allow_dynamic_clients* | boolean | |
| created_at* | number | minimum: 0 |
| created_by* | string (uuid) | null (uuid) | null |
JSONExample
"success"true
"list"
"api_server_scope_id""123e4567-e89b-12d3-a456-426614174000"
"api_server_id""string"
"scope""string"
"description""string"
"allow_dynamic_clients"true
"created_at"1.5
"created_by""123e4567-e89b-12d3-a456-426614174000"
Example request
bashcurl
curl -X GET 'https://auth.schemavaults.com/api/apis/<api_server_id>/scopes' \
-b 'refresh_token_<auth_server_app_id>=<value>'