For the complete documentation index, see llms.txt. This page is also available as Markdown.

Users

Manage users, licenses and access

List all users

get

Returns all users of the account. This endpoint is not prefixed by {app_short}.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

List of users

application/json
total_countintegerOptional
total_pagesintegerOptional
server_timeinteger · int64Optional
get/users
200

List of users

Get the current user

get

Returns the authenticated user and the associated company account.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Current user and company

application/json
get/users/me
200

Current user and company

Send a push key

post

Registers a push notification key for one of the user's devices.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

Push notification key for a device

idstringOptional

Unique device identifier

keystringOptional

Push key

osstringOptional

Device OS (Android or iOS)

os_versionstringOptional

OS version

app_versionstringOptional

Daxium-Air version

namestringOptional

Device name

Responses
200

Push key registered

application/json
objectOptional
post/users/pushkey
200

Push key registered

List workspace users (or look up by email)

get

Returns the workspace users. If the username parameter is provided, returns the single user matching that email.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

Query parameters
usernamestring · emailOptional

Email address to retrieve a specific user

Responses
200

List of users, or a single user when username is provided

application/json
or
get/{app_short}/users
200

List of users, or a single user when username is provided

Create a user

post

Creates a user. Provide plainPassword for Daxium authentication, or ssoProvider for authentication via the company's SSO provider.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

Body

Body for creating or updating a user. Provide plainPassword for Daxium authentication, or ssoProvider for SSO authentication.

usernamestring · emailRequired

Email address (login), must be unique

activebooleanOptional

Status (active / inactive)

firstNamestringOptional

First name

lastNamestringOptional

Last name

localestring · enumOptional

User language

Possible values:
subscription_idstringOptional

Subscription UUID (see the /subscriptions API)

system_groupsinteger[]Required

System groups: 1 = administrator, 2 = mobile access, 3 = web access

groupsinteger[]Optional

Group identifiers (see the /{app_short}/groups API)

force_login_passwordinteger · enumOptional

[SSO companies only] 0 to deactivate, 1 to force Daxium login/password authentication

Possible values:
ssoProviderinteger · nullableOptional

[SSO companies only] Identifier of the SSO provider to use (provided by Daxium)

Responses
200

User created

application/json

User (object returned by GET APIs)

idintegerOptional

Unique system-generated identifier

usernamestring · emailOptional

Email address (login), must be unique

activebooleanOptional

Status (active / inactive)

first_namestringOptional

First name

last_namestringOptional

Last name

subscription_idstringOptional

UUID of the attached subscription

system_groupsinteger[]Optional

System groups: 1 = administrator, 2 = mobile access, 3 = web access

groupsinteger[]Optional

Identifiers of the user's groups

post/{app_short}/users

Create multiple users (async)

post

Creates up to 100 users asynchronously. Poll the returned callbackUrl.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

Bodyobject · UserInput[]

Body for creating or updating a user. Provide plainPassword for Daxium authentication, or ssoProvider for SSO authentication.

usernamestring · emailRequired

Email address (login), must be unique

activebooleanOptional

Status (active / inactive)

firstNamestringOptional

First name

lastNamestringOptional

Last name

localestring · enumOptional

User language

Possible values:
subscription_idstringOptional

Subscription UUID (see the /subscriptions API)

system_groupsinteger[]Required

System groups: 1 = administrator, 2 = mobile access, 3 = web access

groupsinteger[]Optional

Group identifiers (see the /{app_short}/groups API)

force_login_passwordinteger · enumOptional

[SSO companies only] 0 to deactivate, 1 to force Daxium login/password authentication

Possible values:
ssoProviderinteger · nullableOptional

[SSO companies only] Identifier of the SSO provider to use (provided by Daxium)

Responses
200

Async job accepted

application/json
callbackUrlstringOptional

URL to poll for async job status

post/{app_short}/users/multiple

Update multiple users (async)

put

Updates up to 100 users asynchronously. Poll the returned callbackUrl.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

Bodyobject · UserInput[]

Body for creating or updating a user. Provide plainPassword for Daxium authentication, or ssoProvider for SSO authentication.

usernamestring · emailRequired

Email address (login), must be unique

activebooleanOptional

Status (active / inactive)

firstNamestringOptional

First name

lastNamestringOptional

Last name

localestring · enumOptional

User language

Possible values:
subscription_idstringOptional

Subscription UUID (see the /subscriptions API)

system_groupsinteger[]Required

System groups: 1 = administrator, 2 = mobile access, 3 = web access

groupsinteger[]Optional

Group identifiers (see the /{app_short}/groups API)

force_login_passwordinteger · enumOptional

[SSO companies only] 0 to deactivate, 1 to force Daxium login/password authentication

Possible values:
ssoProviderinteger · nullableOptional

[SSO companies only] Identifier of the SSO provider to use (provided by Daxium)

Responses
200

Async job accepted

application/json
callbackUrlstringOptional

URL to poll for async job status

put/{app_short}/users/multiple

Poll async user job status

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

callback_idstring · uuidRequired

Callback identifier (UUID)

Responses
200

Status and per-user results

application/json
get/{app_short}/users/multiple/callback/{callback_id}
200

Status and per-user results

Get a user by identifier

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

user_idintegerRequired

User identifier

Responses
200

User object

application/json

User (object returned by GET APIs)

idintegerOptional

Unique system-generated identifier

usernamestring · emailOptional

Email address (login), must be unique

activebooleanOptional

Status (active / inactive)

first_namestringOptional

First name

last_namestringOptional

Last name

subscription_idstringOptional

UUID of the attached subscription

system_groupsinteger[]Optional

System groups: 1 = administrator, 2 = mobile access, 3 = web access

groupsinteger[]Optional

Identifiers of the user's groups

get/{app_short}/users/{user_id}
200

User object

Update a user

patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

user_idintegerRequired

User identifier

Body

Body for creating or updating a user. Provide plainPassword for Daxium authentication, or ssoProvider for SSO authentication.

usernamestring · emailRequired

Email address (login), must be unique

activebooleanOptional

Status (active / inactive)

firstNamestringOptional

First name

lastNamestringOptional

Last name

localestring · enumOptional

User language

Possible values:
subscription_idstringOptional

Subscription UUID (see the /subscriptions API)

system_groupsinteger[]Required

System groups: 1 = administrator, 2 = mobile access, 3 = web access

groupsinteger[]Optional

Group identifiers (see the /{app_short}/groups API)

force_login_passwordinteger · enumOptional

[SSO companies only] 0 to deactivate, 1 to force Daxium login/password authentication

Possible values:
ssoProviderinteger · nullableOptional

[SSO companies only] Identifier of the SSO provider to use (provided by Daxium)

Responses
200

User updated

application/json

User (object returned by GET APIs)

idintegerOptional

Unique system-generated identifier

usernamestring · emailOptional

Email address (login), must be unique

activebooleanOptional

Status (active / inactive)

first_namestringOptional

First name

last_namestringOptional

Last name

subscription_idstringOptional

UUID of the attached subscription

system_groupsinteger[]Optional

System groups: 1 = administrator, 2 = mobile access, 3 = web access

groupsinteger[]Optional

Identifiers of the user's groups

patch/{app_short}/users/{user_id}
200

User updated

Last updated

Was this helpful?