PUT
/api/apis/{api_server_id}/jwks-access-keyAuthenticatedRegenerate a JWKS access key
Rotates an API server's JWKS access key: every previous key is deactivated and a new key pair is created, whose private key is returned once. Works whether or not a key existed before. No request body.
operationId
put_api_apis_api_server_id_jwks_access_keyAPI 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 of a user-owned API server, or platform administrators. Refused for the auth server's own API server, which is the JWKS provider itself.
Path parameters
| Name | Type | Description |
|---|---|---|
| api_server_id* | string | API server id |
Responses
application/json
JwksAccessKeyGeneratedResponse
| Property | Type | Description |
|---|---|---|
| success* | true | |
| message* | string | |
| key_id* | string | Identifier of the new key pair |
| private_key* | string | PEM-encoded private key. Shown exactly once; the auth server keeps only the public key. |
JSONExample
"success"true
"message""string"
"key_id""string"
"private_key""string"
Example request
bashcurl
curl -X PUT 'https://auth.schemavaults.com/api/apis/<api_server_id>/jwks-access-key' \
-b 'refresh_token_<auth_server_app_id>=<value>'