Create an administrator

Creates an administrator in the current account.

By default, the new administrator receives an access email. Set send_credentials to false to skip it.

By default, the administrator receives the default permissions of the selected role across the whole account. Send product_ids to limit those default permissions to the listed products, or send policies (in the same format as PUT /administrators/{administrator_id}/permissions) to grant exactly the permissions listed there instead. Sending policies and product_ids together returns validation_failed. Both require the administrators.manage_permissions permission. 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. Policies granted in policies cannot exceed what the caller can grant: an administrator (OAuth access token) grants what their own permissions grant, a credential only the delegable permissions of its own policies. Requests that exceed these limits return delegation_limit_exceeded.

Header Parameters

Response Body

curl -X POST "https://example.com/administrators" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "email": "[email protected]",    "name": "string",    "role": "string"  }'

{  "data": {    "created_at": "2019-08-24T14:15:22Z",    "deleted": true,    "email": "[email protected]",    "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"  }}