curl --request POST \
  --url https://api.arize.com/v2/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Jane Smith",
  "email": "jane.smith@example.com",
  "role": {
    "type": "PREDEFINED",
    "name": "MEMBER"
  },
  "invite_mode": "EMAIL_LINK"
}
'

{
  "id": "VXNlcjoxMjM0NQ==",
  "name": "Jane Smith",
  "email": "jane.smith@example.com",
  "created_at": "2024-01-01T12:00:00Z",
  "status": "ACTIVE",
  "role": {
    "type": "PREDEFINED",
    "name": "MEMBER"
  },
  "is_developer": true
}

{
  "id": "VXNlcjoxMjM0NQ==",
  "name": "Jane Smith",
  "email": "jane.smith@example.com",
  "role": {
    "type": "PREDEFINED",
    "name": "MEMBER"
  },
  "status": "INVITED",
  "is_developer": true,
  "invite_mode": "EMAIL_LINK",
  "created_at": "2024-01-01T12:00:00Z"
}

{
  "status": 400,
  "title": "Invalid request parameters",
  "detail": "The 'name' field is required and must be a non-empty string.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#invalid-request"
}

{
  "status": 401,
  "title": "Authentication required",
  "detail": "You must be authenticated to access this resource.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#authentication-required"
}

{
  "status": 403,
  "title": "Access forbidden",
  "detail": "You do not have permission to access this resource.",
  "instance": "/resource/12345",
  "type": "https://arize.com/docs/ax/rest-reference/errors#access-forbidden"
}

{
  "status": 404,
  "title": "Resource not found",
  "detail": "The requested resource with ID '12345' was not found.",
  "instance": "/resource/12345",
  "type": "https://arize.com/docs/ax/rest-reference/errors#resource-not-found"
}

{
  "status": 409,
  "title": "Resource conflict",
  "detail": "A resource with the given identifier already exists.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#resource-conflict"
}

{
  "status": 422,
  "title": "Unprocessable Entity",
  "detail": "One or more fields failed validation.",
  "instance": "/resource/12345",
  "type": "https://arize.com/docs/ax/rest-reference/errors#unprocessable-entity"
}

{
  "status": 429,
  "title": "Rate limit exceeded",
  "detail": "You have exceeded the allowed number of requests. Please try again later.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#rate-limit-exceeded"
}

Users

Create a user

Create a new account user with explicit invite control.

Invite modes

NONE — add the user directly with no invitation (for SSO-only accounts). The user is immediately active and can log in via the configured identity provider.
EMAIL_LINK — create an INVITED invitation and send the user an email with a link to complete the invitation flow. The response has INVITED status, an opaque invitation ID, and the email address as its name. This response does not identify whether the recipient has another account.
TEMPORARY_PASSWORD — create an INVITED invitation with a temporary password (returned once in the response). The user must reset it on first login.

Idempotency on email

For EMAIL_LINK, an identical pending invitation with a valid link returns 200 OK after another email delivery attempt succeeds. A retry keeps the saved invitation and its valid link. If delivery fails, the request returns a service error and can be retried. Revoke a pending invitation before changing its requested access. An expired invitation can be replaced with a new link (201 Created). New requests return 201 Created regardless of the recipient’s account status. Responses do not reveal the recipient’s account or move eligibility.

For TEMPORARY_PASSWORD:

Existing state	Behavior	Response
No prior invitation	Create an `INVITED` user with a temporary password	`201 Created`
`INVITED` (not yet accepted)	Return the existing invitation without a password	`200 OK`
`ACTIVE`	Email belongs to an existing member	`409 Conflict`
`EXPIRED`	Create a new invitation with a temporary password	`201 Created`
`inactive`	User has been deactivated and cannot be re-invited	`409 Conflict`

When invite_mode is NONE and the email already belongs to an active account member, the request returns 409 Conflict.

If email delivery fails after the invitation is saved, repeat the identical creation request or find the invitation in the users list and call its resend endpoint. Both paths attempt delivery again. Concurrent identical creation requests can send more than one email with the same valid link. A pending invitation with different requested access must be revoked before replacement.

Payload requirements

name — required, 1–255 characters
email — required, must be a valid email address; used as the idempotency key
role — required, one of ADMIN, MEMBER, ANNOTATOR; sets the account-level role
invite_mode — required, one of NONE, EMAIL_LINK, TEMPORARY_PASSWORD

For accounts that require SAML, new recipients receive a SAML sign-in link. Existing recipients follow the account-move flow and must satisfy the destination account’s SAML requirements. Invitation links do not bypass SAML authentication. For EMAIL_LINK, the supplied name does not replace the recipient’s profile name.

Requires account admin or member role. Admins can assign any role; members can only assign MEMBER or ANNOTATOR.

This endpoint is in beta, read more here.

POST

users

curl --request POST \
  --url https://api.arize.com/v2/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Jane Smith",
  "email": "jane.smith@example.com",
  "role": {
    "type": "PREDEFINED",
    "name": "MEMBER"
  },
  "invite_mode": "EMAIL_LINK"
}
'

{
  "id": "VXNlcjoxMjM0NQ==",
  "name": "Jane Smith",
  "email": "jane.smith@example.com",
  "created_at": "2024-01-01T12:00:00Z",
  "status": "ACTIVE",
  "role": {
    "type": "PREDEFINED",
    "name": "MEMBER"
  },
  "is_developer": true
}

{
  "id": "VXNlcjoxMjM0NQ==",
  "name": "Jane Smith",
  "email": "jane.smith@example.com",
  "role": {
    "type": "PREDEFINED",
    "name": "MEMBER"
  },
  "status": "INVITED",
  "is_developer": true,
  "invite_mode": "EMAIL_LINK",
  "created_at": "2024-01-01T12:00:00Z"
}

{
  "status": 400,
  "title": "Invalid request parameters",
  "detail": "The 'name' field is required and must be a non-empty string.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#invalid-request"
}

{
  "status": 401,
  "title": "Authentication required",
  "detail": "You must be authenticated to access this resource.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#authentication-required"
}

{
  "status": 403,
  "title": "Access forbidden",
  "detail": "You do not have permission to access this resource.",
  "instance": "/resource/12345",
  "type": "https://arize.com/docs/ax/rest-reference/errors#access-forbidden"
}

{
  "status": 404,
  "title": "Resource not found",
  "detail": "The requested resource with ID '12345' was not found.",
  "instance": "/resource/12345",
  "type": "https://arize.com/docs/ax/rest-reference/errors#resource-not-found"
}

{
  "status": 409,
  "title": "Resource conflict",
  "detail": "A resource with the given identifier already exists.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#resource-conflict"
}

{
  "status": 422,
  "title": "Unprocessable Entity",
  "detail": "One or more fields failed validation.",
  "instance": "/resource/12345",
  "type": "https://arize.com/docs/ax/rest-reference/errors#unprocessable-entity"
}

{
  "status": 429,
  "title": "Rate limit exceeded",
  "detail": "You have exceeded the allowed number of requests. Please try again later.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#rate-limit-exceeded"
}

Authorizations

Authorization

string

header

required

Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format

Body

application/json

Body containing user creation parameters and invite control.

User-level developer permissions are determined by the assigned account role.

name

string

required

Full name of the new user

Required string length: 1 - 255

string<email>

required

Email address of the user to invite

Example:

"user@example.com"

role

object

required

Strict request form of UserRoleAssignment. Used in write request bodies.

PREDEFINED: { "type": "PREDEFINED", "name": "ADMIN" | "MEMBER" | "ANNOTATOR" }
CUSTOM: { "type": "CUSTOM", "id": "<encoded-role-id>" }

Option 1
Option 2

Show child attributes

invite_mode

enum<string>

required

Controls whether and how an invitation is sent

Available options:

NONE,

EMAIL_LINK,

TEMPORARY_PASSWORD

Response

An account user object

An account user represents a member of the account. Users can be listed, updated, or removed from the account. Invitations in the acceptance flow appear as users with INVITED or EXPIRED status. Their IDs identify the invitation until acceptance; refresh the user list after acceptance to obtain the member ID.

string

required

A universally unique identifier (base64-encoded opaque string).

Example:

"RW50aXR5OjEyMzQ1"

name

string

required

Display name of the user. Pending invitations in the acceptance flow use the email address until acceptance.

string<email>

required

An email address

Example:

"user@example.com"

created_at

string<date-time>

required

Timestamp for when the user or invitation was created

status

enum<string>

required

Current status of the user in the account.

ACTIVE: User has verified their email and can access the platform.
INVITED: User has a pending invitation whose link is still valid.
EXPIRED: The invitation link has expired or is missing. A new invite is required.

Available options:

ACTIVE,

INVITED,

EXPIRED

role

object

required

An account-level role assignment. Discriminated by type:

PREDEFINED: one of the predefined roles (admin, member, annotator)
CUSTOM: a custom RBAC role identified by its ID

Note: CUSTOM role assignments are not yet supported and are reserved for future use.

Option 1
Option 2

Show child attributes

is_developer

boolean

required

Whether the user has developer permissions (can use the Arize API)

Skills

MCP server

API reference

API clients

Create a user

Authorizations

Body

Response