Utilisateur·ice

/v1/users/{username}

Utilisez ce point de terminaison pour récupérer, mettre à jour ou supprimer un compte utilisateur.

Consultation

Obtenez des informations sur un compte utilisateur spécifique.

Exemple

Pour récupérer un compte utilisateur, envoyez une requête GET sur le point de terminaison /users/{username} :

GET /v1/users/username
Authorization: Bearer your-auth-token

En cas de succès, la requête renvoie un code de statut HTTP 200 OK et une charge utile similaire à ce qui suit :

{
   "users": [{
     "ROLES": "ROLE_ADMIN | ROLE_USER",
     "username": "username"
   }]
}

Mise à jour

Un·e utilisateur·ice avec le rôle ROLE_ADMIN peut mettre à jour le mot de passe associé aux comptes utilisateur dotés des rôles ROLE_ADMIN et ROLE_USER. Les utilisateurs individuels peuvent également mettre à jour le mot de passe pour leur propre compte. La mise à jour d’un mot de passe de compte utilisateur n’invalide pas les tokens d’accès associés à l’utilisateur·ice. Actuellement, seul·e l’utilisateur·ice admin peut être associé·e à ROLE_ADMIN ; les autres utilisateur·ices disposent de ROLE_USER.

Exemple

Pour mettre à jour le mot de passe d’un compte, fournissez le token Bearer avec le nom d’utilisateur et le nouveau mot de passe.

PUT /v1/users/username
Authorization: Bearer your-auth-token
   
{
  "password": "new-password"
}

En cas de succès, le mot de passe associé au nom d’utilisateur·ice est mis à jour. Le code de statut HTTP 200 OK est renvoyé avec une charge utile similaire à ce qui suit :

{
   "users": [{
      "username": "username"
   }]
}

Suppression

Si un compte est compromis ou s’il y a d’autres raisons de le supprimer, l’admin doit le supprimer. Une fois que vous avez supprimé un compte, tous les tokens associés à ce compte sont supprimés du système.

Exemple

Utilisez l’appel d’API suivant pour supprimer un compte utilisateur, où username est le nom du compte utilisateur que vous voulez supprimer. Le token Bearer est le token appartenant au compte admin.

DELETE /v1/users/username
Authorization: Bearer your-auth-token

En cas de réussite, le compte utilisateur est supprimé. La réponse comprend le code de statut HTTP 200 OK et la charge utile suivante :

{
   "users": [{
      "username": "username"
   }]
}

Codes d’erreur