API de gestion des utilisateurs

L'API de gestions des utilisateurs de Piano Analytics permet de lister, créer, suspendre et supprimer des utilisateurs dans votre organisation.

Authentification

Vous devez d'abord créer une API-Key depuis la page de votre profil dans Piano Analytics.

Pour authentifier vos appels, passez l'API-Key dans le header de chaque appel API, avec le header suivant : x-api-key=ACCESSKEY_SECRETKEY

Info

Ce service est réservé aux administrateurs d'organisations.

Gestion des utilisateurs

Lister les utilisateurs

Objet : obtention de la liste des utilisateurs de votre organisation

Méthode	GET
URL	/v1/access/users
Response code	200
Response description	Array of user objects

Payload:

CODE

[
  {
    "id": 0,
    "creationDate": "string",
    "closingDate": "string",
    "cultureCode": "string",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
  }
]

Créer des utilisateurs

Objet : création de comptes utilisateurs

Méthode	POST
URL	/v1/access/user/create
Response code	204
Response description	The user's account is successfully created and added to the organization

Request body

CODE

{
  "email": "string",
  "firstName": "string",
  "lastName": "string",
}

Suspendre des utilisateurs

Objet : suspension de comptes d'utilisateurs à une date donnée. Cela indique qu'à compter de cette date, les droits de l'utilisateur seront suspendus. L'utilisateur appartiendra toujours aux groupes de l'organisation, mais ses droits sont désactivés. Il est possible de réactiver le compte d'un utilisateur en supprimant la date de fin. Pour cela vous pouvez effectuer un appel API avec le paramètre "endDate" égal à null.

Méthode	PATCH
URL	/v1/access/user/enddate
Response code	204
Response description	The user's account is successfully updated

Request body

CODE

{
  "email": "string",
  "endDate": "string"
}

Les dates doivent être au format yyyy-mm-dd.

Supprimer des utilisateurs

Objet: suppression de comptes utilisateurs à partir de leur adresse email.

Méthode	POST
URL	/v1/access/user/delete
Response code	204
Response description	The user's account is successfully deleted from the organization

Request body

CODE

{
  "email": "string"
}

Gestion des sites

Objet: obtenir la liste des sites de votre organisation

Méthode	GET
URL	/v1/access/sites
Response code	200
Response description	Array of site objects

Payload

CODE

[
  {
    "contractId": 0,
    "closingDate": "string",
    "siteId": 0,
    "siteName": "string"
  }
]

Les dates doivent être au format yyyy-mm-dd.

Limitations & restrictions

Ce service est réservé aux administrateurs d'organisations.

Pour des raisons de sécurité, il n'est pas possible de supprimer ou suspendre un administrateur ou un compte délégué via cette API. Cette action doit être effectuée depuis l'interface de gestion des droits d'accès.