Retrieve administrator permissions
/administrators/{administrator_id}/permissionsReturns the administrator's role, the full set of granular permissions with the state of each one, and the IDs of the products the administrator can access.
Autonomous mode: 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
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 <= 64Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/administrators/string/permissions"{ "data": { "object": "administrator_permissions", "permissions": {}, "product_ids": [ "string" ], "revision": "string", "role": "root" }}Resend the access email POST
Resends the access email to the administrator. This operation replaces the administrator's password with a new one, which is sent by email and never included in the response. The email is sent asynchronously. An access email can be sent to the same administrator at most once every 10 minutes. Earlier attempts return `email_recently_sent`.
Update administrator permissions PUT
Replaces the administrator's role, granular permissions, and product access in a single operation. Permissions not granted in `permissions` are disabled, and product access is set to exactly the products listed in `product_ids`. If any part of the request is rejected, no changes are applied. Permission keys that do not exist in the permission catalog return `validation_failed`. The API cannot assign the `root` or `master_admin` role, and every permission granted must be part of the selected role's default permissions. Requests that exceed these limits return `delegation_limit_exceeded`. To avoid overwriting a newer version, send the `ETag` returned by the retrieve administrator operation in the `If-Match` header. The response includes the new `ETag`.