Retrieve an administrator
/administrators/{administrator_id}Retrieves an administrator by its public ID.
The response includes an ETag representing the current revision. Send this value in the If-Match header when updating the administrator or its permissions to avoid overwriting a newer version.
Administrators in the trash are not returned by this operation.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/administrators/string"{ "data": { "created_at": "2019-08-24T14:15:22Z", "deleted": true, "email": "user@example.com", "id": "string", "last_login_at": "2019-08-24T14:15:22Z", "name": "string", "object": "administrator", "product_ids": [ "string" ], "revision": "string", "role": "root", "status": "active", "two_factor_enabled": true, "updated_at": "2019-08-24T14:15:22Z" }}Create an administrator POST
Creates an administrator in the current account. By default, the new administrator receives an access email. Set `send_credentials` to `false` to skip it. You can assign granular permissions and product access in the same request with `permissions` and `product_ids`, which also requires the `administrators.manage_permissions` permission. When either field is supplied, the administrator receives only the permissions listed in `permissions` instead of the role's default permissions. If any part of the request is rejected, no administrator is created. The API cannot create administrators with the `root` or `master_admin` role, and creating an administrator with the `admin` role requires the `administrators.manage_permissions` permission. Every permission granted in `permissions` must be part of the selected role's default permissions. Requests that exceed these limits return `delegation_limit_exceeded`.
Update an administrator PATCH
Updates an administrator's name or email address, or restores an administrator from the trash. To restore a trashed administrator, set `deleted` to `false`. Restoring requires the `administrators.delete` permission and is rejected with `validation_failed` if another active administrator already uses the same email address. The `status` field is accepted but has no effect. Roles and permissions can only be changed through the update administrator permissions operation. Fields such as `role` and `password` are rejected with `unknown_field`. Send the `ETag` returned by the retrieve operation in the `If-Match` header to avoid overwriting a newer version.