Retrieve a paginated list of all users in the system.
Cursor for pagination (base64-encoded user ID)
The max number of users to return at a time.
100
GET /v1/users HTTP/1.1
Host:
Accept: */*
{
"data": [
{
"id": "text",
"created_at": "2025-07-27T05:24:35.530Z",
"updated_at": "2025-07-27T05:24:35.530Z",
"email": "text",
"username": "text",
"role": "SYSTEM",
"auth_method": "text",
"password": "text",
"password_needs_reset": true
}
],
"next_cursor": "text"
}
Delete an existing user by their unique GlobalID.
The GlobalID of the user (e.g. 'VXNlcjox').
DELETE /v1/users/{user_id} HTTP/1.1
Host:
Accept: */*
No content
Create a new user with the specified configuration.
true
POST /v1/users HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 124
{
"user": {
"email": "text",
"username": "text",
"role": "SYSTEM",
"auth_method": "text",
"password": "text"
},
"send_welcome_email": true
}
{
"data": {
"id": "text",
"created_at": "2025-07-27T05:24:35.530Z",
"updated_at": "2025-07-27T05:24:35.530Z",
"email": "text",
"username": "text",
"role": "SYSTEM",
"auth_method": "text",
"password": "text",
"password_needs_reset": true
}
}