Update administrator permissions
/administrators/{administrator_id}/permissionsReplaces the administrator's role and policies in a single operation. Each item of policies is a policy in the same format as POST /credentials/{credential_id}/policies: the capabilities it grants and the resources they apply to. The new policies replace all previous ones; if any part of the request is rejected, no changes are applied.
Full-access roles (root and master_admin) have no policies: send an empty policies array with them, or the request returns validation_failed.
Nobody can grant more than they have. When the caller is an administrator (OAuth access token), the limit is that administrator's own permissions: a full-access administrator grants anything, including administrators.* and credentials.*; any other administrator grants only what their own policies grant. A credential grants only the delegable permissions of its own policies, never administrators.* or credentials.*, and never assigns a full-access role. Requests that exceed these limits return delegation_limit_exceeded. An administrator cannot change their own permissions (409, reason: self_modification).
To avoid overwriting a newer version, send the ETag returned by the retrieve administrator permissions operation in the If-Match header. The response includes the new ETag.
Credential: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Public ID of the administrator, prefixed with adm_.
Header Parameters
Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.
Expected revision of the resource, in the same format as the ETag header (W/"<type>:<id>:<revision>"). If the resource has changed since that revision, the request fails with 412 and the revision_mismatch error code. * matches the current revision. Any other value fails with 400 and the if_match_invalid error code. When omitted, the update is applied to the current revision.
Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.
length <= 64Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/administrators/string/permissions" \ -H "Content-Type: application/json" \ -d '{ "policies": [ { "capabilities": [ "string" ], "resources": [ { "selector": "string", "type": "string" } ] } ], "role": "string" }'{ "data": { "full_access": true, "object": "administrator_permissions", "policies": [ { "capabilities": [ "string" ], "id": "string", "object": "policy", "published_at": "2019-08-24T14:15:22Z", "published_by": { "id": "string", "kind": "admin" }, "resources": [ { "ids": [ "string" ], "include_future": true, "parent": "string", "selector": "instance", "type": "instance" } ], "version": 0 } ], "revision": "string", "role": "root" }}Retrieve administrator permissions GET
Returns the administrator's role and the policies of their active policy revision, in the same format as credential policies. Full-access roles (`root` and `master_admin`) return `full_access: true` and no policies. Use the returned `ETag` in `If-Match` when updating the permissions.
General settings14
Next Page