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.

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 permissions is supplied, the administrator receives only the permissions listed there instead of the role's default permissions; product_ids alone keeps 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.

Header Parameters

Response Body

curl -X POST "https://example.com/administrators" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com",    "name": "string",    "role": "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"  }}