Developers
Administrators8

Resend the access email

POST/administrators/{administrator_id}/invitation-emails

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.

Authorization

AuthorizationBearer <token>

Credential: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

administrator_id*string

Public ID of the administrator, prefixed with adm_.

Header Parameters

Idempotency-Key*string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Required by this operation: a missing key returns idempotency_key_required, and a malformed key returns idempotency_key_invalid. Repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

X-Client-Request-Id?string

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.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/administrators/string/invitation-emails" \  -H "Idempotency-Key: string"
{  "data": {    "object": "invitation_email",    "status": "queued"  }}

Delete an administrator DELETE

Moves the administrator to the trash. A trashed administrator can be restored with the update operation by setting `deleted` to `false`. The last `root` administrator in the account cannot be deleted, and an administrator acting with their OAuth access token cannot delete themselves. Administrators with the `root` or `master_admin` role cannot be deleted through the API; attempts return `delegation_limit_exceeded`. API credentials created by the deleted administrator are not revoked.

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.