Utilisateurs

Gérer les utilisateurs, les licences et les accès

Lister tous les utilisateurs

get

Retourne tous les utilisateurs du compte. Cet endpoint n'est pas préfixé par {app_short}.

Autorisations

BearerAuth

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Réponses

200

Liste des utilisateurs

application/json

total_countintegerOptionnel

total_pagesintegerOptionnel

server_timeinteger · int64Optionnel

get/users

HTTPcURLJavaScriptPython

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

200

Liste des utilisateurs

{
  "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
}

Récupérer l'utilisateur courant

get

Retourne l'utilisateur authentifié ainsi que le compte (société) associé.

Autorisations

BearerAuth

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Réponses

200

Utilisateur courant et société

application/json

get/users/me

HTTPcURLJavaScriptPython

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

200

Utilisateur courant et société

{
  "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"
  }
}

Envoyer une clé push

post

Enregistre une clé de notification push pour un appareil de l'utilisateur.

Autorisations

BearerAuth

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Corps

application/json

Clé de notification push d'un appareil

idstringOptionnel

Identifiant unique de l'appareil

keystringOptionnel

Clé push

osstringOptionnel

Système d'exploitation de l'appareil (android ou iOS)

os_versionstringOptionnel

Version de l'OS

app_versionstringOptionnel

Version de Daxium-Air

namestringOptionnel

Nom de l'appareil

Réponses

200

Clé push enregistrée

application/json

objectOptionnel

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

Clé push enregistrée

{}

Lister les utilisateurs d'un vertical métier (ou rechercher par e-mail)

get

Retourne les utilisateurs du vertical métier. Si le paramètre username est fourni, retourne l'utilisateur unique correspondant à cet e-mail.

Autorisations

BearerAuth

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Paramètres de chemin

app_shortstringRequis

Nom court de l'instance (ex. daxium-test)

Paramètres de requête

usernamestring · emailOptionnel

Adresse e-mail pour récupérer un utilisateur précis

Réponses

200

Liste d'utilisateurs, ou utilisateur unique si username est fourni

application/json

ou

get/{app_short}/users

HTTPcURLJavaScriptPython

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

200

Liste d'utilisateurs, ou utilisateur unique si username est fourni

{
  "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
}

Créer un utilisateur

post

Crée un utilisateur. Fournissez plainPassword pour une authentification Daxium, ou ssoProvider pour une authentification via le fournisseur SSO de la société.

Autorisations

BearerAuth

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Paramètres de chemin

app_shortstringRequis

Nom court de l'instance (ex. daxium-test)

Corps

application/json

Corps de création ou de mise à jour d'un utilisateur. Fournissez plainPassword pour une authentification Daxium, ou ssoProvider pour une authentification SSO.

usernamestring · emailRequis

Adresse e-mail (identifiant de connexion), unique

activebooleanOptionnel

Statut (actif / inactif)

firstNamestringOptionnel

Prénom

lastNamestringOptionnel

Nom

localestring · enumOptionnel

Langue de l'utilisateur

Valeurs possibles:

subscription_idstringOptionnel

UUID de l'abonnement (voir l'API /subscriptions)

system_groupsinteger[]Requis

Groupes système : 1 = administrateur, 2 = accès mobile, 3 = accès web

groupsinteger[]Optionnel

Identifiants des groupes (voir l'API /{app_short}/groups)

force_login_passwordinteger · enumOptionnel

[Sociétés SSO uniquement] 0 pour désactiver, 1 pour forcer l'authentification login/mot de passe Daxium

Valeurs possibles:

ssoProviderinteger · nullableOptionnel

[Sociétés SSO uniquement] Identifiant du fournisseur SSO à utiliser (fourni par Daxium)

Réponses

200

Utilisateur créé

application/json

Utilisateur (objet retourné par les API GET)

idintegerOptionnel

Identifiant unique généré par le système

usernamestring · emailOptionnel

Adresse e-mail (identifiant de connexion), unique

activebooleanOptionnel

Statut (actif / inactif)

first_namestringOptionnel

Prénom

last_namestringOptionnel

Nom

subscription_idstringOptionnel

UUID de l'abonnement rattaché

system_groupsinteger[]Optionnel

Groupes système : 1 = administrateur, 2 = accès mobile, 3 = accès web

groupsinteger[]Optionnel

Identifiants des groupes de l'utilisateur

400

Données invalides (mot de passe, ssoProvider, groupes ou abonnement invalides)

application/json

409

L'adresse e-mail (username) existe déjà

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"
  }
}

Créer plusieurs utilisateurs (asynchrone)

post

Crée jusqu'à 100 utilisateurs de manière asynchrone. Interrogez le callbackUrl retourné.

Autorisations

BearerAuth

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Paramètres de chemin

app_shortstringRequis

Nom court de l'instance (ex. daxium-test)

Corpsobject · UserInput[]

application/json

Corps de création ou de mise à jour d'un utilisateur. Fournissez plainPassword pour une authentification Daxium, ou ssoProvider pour une authentification SSO.

usernamestring · emailRequis

Adresse e-mail (identifiant de connexion), unique

activebooleanOptionnel

Statut (actif / inactif)

firstNamestringOptionnel

Prénom

lastNamestringOptionnel

Nom

localestring · enumOptionnel

Langue de l'utilisateur

Valeurs possibles:

subscription_idstringOptionnel

UUID de l'abonnement (voir l'API /subscriptions)

system_groupsinteger[]Requis

Groupes système : 1 = administrateur, 2 = accès mobile, 3 = accès web

groupsinteger[]Optionnel

Identifiants des groupes (voir l'API /{app_short}/groups)

force_login_passwordinteger · enumOptionnel

[Sociétés SSO uniquement] 0 pour désactiver, 1 pour forcer l'authentification login/mot de passe Daxium

Valeurs possibles:

ssoProviderinteger · nullableOptionnel

[Sociétés SSO uniquement] Identifiant du fournisseur SSO à utiliser (fourni par Daxium)

Réponses

200

Job asynchrone accepté

application/json

callbackUrlstringOptionnel

URL à interroger pour suivre l'avancement du job asynchrone

400

Corps vide ou plus de 100 utilisateurs

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"
}

Mettre à jour plusieurs utilisateurs (asynchrone)

put

Met à jour jusqu'à 100 utilisateurs de manière asynchrone. Interrogez le callbackUrl retourné.

Autorisations

BearerAuth

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Paramètres de chemin

app_shortstringRequis

Nom court de l'instance (ex. daxium-test)

Corpsobject · UserInput[]

application/json

Corps de création ou de mise à jour d'un utilisateur. Fournissez plainPassword pour une authentification Daxium, ou ssoProvider pour une authentification SSO.

usernamestring · emailRequis

Adresse e-mail (identifiant de connexion), unique

activebooleanOptionnel

Statut (actif / inactif)

firstNamestringOptionnel

Prénom

lastNamestringOptionnel

Nom

localestring · enumOptionnel

Langue de l'utilisateur

Valeurs possibles:

subscription_idstringOptionnel

UUID de l'abonnement (voir l'API /subscriptions)

system_groupsinteger[]Requis

Groupes système : 1 = administrateur, 2 = accès mobile, 3 = accès web

groupsinteger[]Optionnel

Identifiants des groupes (voir l'API /{app_short}/groups)

force_login_passwordinteger · enumOptionnel

[Sociétés SSO uniquement] 0 pour désactiver, 1 pour forcer l'authentification login/mot de passe Daxium

Valeurs possibles:

ssoProviderinteger · nullableOptionnel

[Sociétés SSO uniquement] Identifiant du fournisseur SSO à utiliser (fourni par Daxium)

Réponses

200

Job asynchrone accepté

application/json

callbackUrlstringOptionnel

URL à interroger pour suivre l'avancement du job asynchrone

400

Corps vide ou plus de 100 utilisateurs

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"
}

Consulter le statut d'un job asynchrone d'utilisateurs

get

Autorisations

BearerAuth

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Paramètres de chemin

app_shortstringRequis

Nom court de l'instance (ex. daxium-test)

callback_idstring · uuidRequis

Identifiant de callback (UUID)

Réponses

200

Statut et résultats par utilisateur

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

Statut et résultats par utilisateur

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

Récupérer un utilisateur par son identifiant

get

Autorisations

BearerAuth

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Paramètres de chemin

app_shortstringRequis

Nom court de l'instance (ex. daxium-test)

user_idintegerRequis

Identifiant de l'utilisateur

Réponses

200

Objet utilisateur

application/json

Utilisateur (objet retourné par les API GET)

idintegerOptionnel

Identifiant unique généré par le système

usernamestring · emailOptionnel

Adresse e-mail (identifiant de connexion), unique

activebooleanOptionnel

Statut (actif / inactif)

first_namestringOptionnel

Prénom

last_namestringOptionnel

Nom

subscription_idstringOptionnel

UUID de l'abonnement rattaché

system_groupsinteger[]Optionnel

Groupes système : 1 = administrateur, 2 = accès mobile, 3 = accès web

groupsinteger[]Optionnel

Identifiants des groupes de l'utilisateur

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

Objet utilisateur

{
  "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"
  }
}

Mettre à jour un utilisateur

patch

Autorisations

BearerAuth

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Paramètres de chemin

app_shortstringRequis

Nom court de l'instance (ex. daxium-test)

user_idintegerRequis

Identifiant de l'utilisateur

Corps

application/json

Corps de création ou de mise à jour d'un utilisateur. Fournissez plainPassword pour une authentification Daxium, ou ssoProvider pour une authentification SSO.

usernamestring · emailRequis

Adresse e-mail (identifiant de connexion), unique

activebooleanOptionnel

Statut (actif / inactif)

firstNamestringOptionnel

Prénom

lastNamestringOptionnel

Nom

localestring · enumOptionnel

Langue de l'utilisateur

Valeurs possibles:

subscription_idstringOptionnel

UUID de l'abonnement (voir l'API /subscriptions)

system_groupsinteger[]Requis

Groupes système : 1 = administrateur, 2 = accès mobile, 3 = accès web

groupsinteger[]Optionnel

Identifiants des groupes (voir l'API /{app_short}/groups)

force_login_passwordinteger · enumOptionnel

[Sociétés SSO uniquement] 0 pour désactiver, 1 pour forcer l'authentification login/mot de passe Daxium

Valeurs possibles:

ssoProviderinteger · nullableOptionnel

[Sociétés SSO uniquement] Identifiant du fournisseur SSO à utiliser (fourni par Daxium)

Réponses

200

Utilisateur mis à jour

application/json

Utilisateur (objet retourné par les API GET)

idintegerOptionnel

Identifiant unique généré par le système

usernamestring · emailOptionnel

Adresse e-mail (identifiant de connexion), unique

activebooleanOptionnel

Statut (actif / inactif)

first_namestringOptionnel

Prénom

last_namestringOptionnel

Nom

subscription_idstringOptionnel

UUID de l'abonnement rattaché

system_groupsinteger[]Optionnel

Groupes système : 1 = administrateur, 2 = accès mobile, 3 = accès web

groupsinteger[]Optionnel

Identifiants des groupes de l'utilisateur

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

Utilisateur mis à jour

{
  "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"
  }
}