Sign in

v2

latestOpenAPI 3.0.3Apache-2.02026-08-07119359591.9 KB
Users

Update a user

Update a user's display name and/or developer permission.

Payload Requirements

  • At least one of name or is_developer must be provided.
  • name must be 1–255 characters. Leading and trailing whitespace is stripped before validation; whitespace-only values (e.g. " ") are rejected with 400.
  • Setting is_developer to its current value is a no-op (idempotent).

Example valid requests:

{ "name": "Jane Smith" }
{ "is_developer": true }
{ "name": "Jane Smith", "is_developer": false }

Example invalid requests:

  • {} — at least one field must be provided
  • { "name": " " } — name cannot be whitespace only

Updating name requires account admin role or USER_UPDATE permission.

Updating is_developer requires account admin role. Callers without account admin that include is_developer in the body receive 403.

<Note>This endpoint is in beta, read more here.</Note>

patch/v2/users/{user_id}

Path parameters

user_idstring required

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

Example:RW50aXR5OjEyMzQ1

The unique user identifier (base64)

Request body

namestring

Updated display name for the user

is_developerboolean

Set to true to grant developer permissions, or false to revoke them. When omitted, the current value is preserved.

Response

An account user object

idstring required

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

namestring required

Display name of the user

emailstring email required

An email address

created_atstring date-time required

Timestamp for when the user was created

status'ACTIVE' | 'INVITED' | 'EXPIRED' required

Current status of the user in the account.

  • ACTIVE: User has verified their email and can access the platform.
  • INVITED: User has been invited and their verification token is still valid.
  • EXPIRED: User was invited but their verification token has expired or is missing. A new invite is required.
is_developerboolean required

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

Example response

{
  "id": "RW50aXR5OjEyMzQ1",
  "email": "user@example.com",
  "role": {
    "id": "RW50aXR5OjEyMzQ1"
  }
}