Skip to main content
POST
/
api
/
users
Error
A valid request URL is required to generate request examples
{
  "user": {
    "id": "<string>",
    "name": "<string>",
    "email": "jsmith@example.com",
    "role_id": 123,
    "role": {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "is_system_role": true
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "teams": [
      {
        "id": "<string>",
        "name": "<string>",
        "business_unit_id": "<string>",
        "business_unit_name": "<string>"
      }
    ],
    "access_profile": {
      "id": 123,
      "user_id": "<string>",
      "parent_profile_id": 123,
      "name": "<string>",
      "is_active": true,
      "expires_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <API key>. Virtual keys, dashboard/user/session tokens, and x-api-key headers are not supported on management APIs.

Body

application/json
​
name
string
required

User's display name

​
email
string<email>
required

User's email address (must be unique)

Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$
​
role_id
integer

Optional RBAC role ID to assign

Response

User created successfully

​
user
object