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

BearerAuth

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

HTTPcURLJavaScriptPython

GET /users HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

List of users

{
  "users": [
    {
      "id": 1,
      "username": "[e-mail]",
      "active": true,
      "first_name": "text",
      "last_name": "text",
      "subscription_id": "text",
      "system_groups": [
        1
      ],
      "groups": [
        1
      ],
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "total_count": 1,
  "total_pages": 1,
  "server_time": 1
}

Get the current user

get

Returns the authenticated user and the associated company account.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Current user and company

application/json

get/users/me

HTTPcURLJavaScriptPython

GET /users/me HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Current user and company

{
  "user": {
    "id": 1,
    "username": "[e-mail]",
    "active": true,
    "first_name": "text",
    "last_name": "text",
    "subscription_id": "text",
    "system_groups": [
      1
    ],
    "groups": [
      1
    ],
    "settings": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "company": {
    "created_at": 1,
    "updated_at": 1,
    "id": 1,
    "title": "text"
  }
}

Send a push key

post

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

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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

HTTPcURLJavaScriptPython

POST /users/pushkey HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "id": "text",
  "key": "text",
  "os": "text",
  "os_version": "text",
  "app_version": "text",
  "name": "text"
}

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

BearerAuth

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

HTTPcURLJavaScriptPython

GET /{app_short}/users HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

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

{
  "users": [
    {
      "id": 1,
      "username": "[e-mail]",
      "active": true,
      "first_name": "text",
      "last_name": "text",
      "subscription_id": "text",
      "system_groups": [
        1
      ],
      "groups": [
        1
      ],
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "total_count": 1,
  "total_pages": 1,
  "server_time": 1
}

Create a user

post

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

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

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

Body

application/json

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

400

Invalid data (password, ssoProvider, groups or subscription invalid)

application/json

409

The email (username) already exists

application/json

post/{app_short}/users

HTTPcURLJavaScriptPython

POST /{app_short}/users HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 250

{
  "username": "[e-mail]",
  "active": true,
  "firstName": "text",
  "lastName": "text",
  "locale": "en",
  "subscription_id": "text",
  "system_groups": [
    1
  ],
  "groups": [
    1
  ],
  "plainPassword": {
    "first": "password",
    "second": "password"
  },
  "force_login_password": 0,
  "ssoProvider": 1
}

{
  "id": 1,
  "username": "[e-mail]",
  "active": true,
  "first_name": "text",
  "last_name": "text",
  "subscription_id": "text",
  "system_groups": [
    1
  ],
  "groups": [
    1
  ],
  "settings": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Create multiple users (async)

post

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

Authorizations

BearerAuth

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[]

application/json

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

400

Empty payload or more than 100 users

application/json

post/{app_short}/users/multiple

HTTPcURLJavaScriptPython

POST /{app_short}/users/multiple HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 252

[
  {
    "username": "[e-mail]",
    "active": true,
    "firstName": "text",
    "lastName": "text",
    "locale": "en",
    "subscription_id": "text",
    "system_groups": [
      1
    ],
    "groups": [
      1
    ],
    "plainPassword": {
      "first": "password",
      "second": "password"
    },
    "force_login_password": 0,
    "ssoProvider": 1
  }
]

{
  "callbackUrl": "text"
}

Update multiple users (async)

put

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

Authorizations

BearerAuth

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[]

application/json

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

400

Empty payload or more than 100 users

application/json

put/{app_short}/users/multiple

HTTPcURLJavaScriptPython

PUT /{app_short}/users/multiple HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 252

[
  {
    "username": "[e-mail]",
    "active": true,
    "firstName": "text",
    "lastName": "text",
    "locale": "en",
    "subscription_id": "text",
    "system_groups": [
      1
    ],
    "groups": [
      1
    ],
    "plainPassword": {
      "first": "password",
      "second": "password"
    },
    "force_login_password": 0,
    "ssoProvider": 1
  }
]

{
  "callbackUrl": "text"
}

Poll async user job status

get

Authorizations

BearerAuth

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}

HTTPcURLJavaScriptPython

GET /{app_short}/users/multiple/callback/{callback_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Status and per-user results

{
  "callbackDetails": {
    "status": "Planned",
    "nbRecordsTodo": 1,
    "nbRecordsDone": 1,
    "nbSuccess": 1,
    "nbErrors": 1,
    "success": [
      {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ],
    "errors": [
      {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ]
  }
}

Get a user by identifier

get

Authorizations

BearerAuth

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}

HTTPcURLJavaScriptPython

GET /{app_short}/users/{user_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

User object

{
  "id": 1,
  "username": "[e-mail]",
  "active": true,
  "first_name": "text",
  "last_name": "text",
  "subscription_id": "text",
  "system_groups": [
    1
  ],
  "groups": [
    1
  ],
  "settings": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Update a user

patch

Authorizations

BearerAuth

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

application/json

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}

HTTPcURLJavaScriptPython

PATCH /{app_short}/users/{user_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 250

{
  "username": "[e-mail]",
  "active": true,
  "firstName": "text",
  "lastName": "text",
  "locale": "en",
  "subscription_id": "text",
  "system_groups": [
    1
  ],
  "groups": [
    1
  ],
  "plainPassword": {
    "first": "password",
    "second": "password"
  },
  "force_login_password": 0,
  "ssoProvider": 1
}

200

User updated

{
  "id": 1,
  "username": "[e-mail]",
  "active": true,
  "first_name": "text",
  "last_name": "text",
  "subscription_id": "text",
  "system_groups": [
    1
  ],
  "groups": [
    1
  ],
  "settings": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}