Méthodes d’API de gestion des utilisateurs user-management-api-methods
Redéfinissez les API méthodes pour gérer les utilisateurs, notamment la création, la mise à jour, la liste, la suppression et le renvoi d’objets utilisateur.
Création d’un utilisateur create-user
Une méthode POST
pour créer un utilisateur.
Demande
POST /api/v1/users/
Exemple de corps de requête
{
"username" : <string>,
"status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
"firstName" : <string>,
"lastName" : <string>,
"email" : <string>,
"title" : <string_may_be_null>,
"phoneNumber" : <string_may_be_null>,
"groups" : [<group_1_id>, ...],
"isAdmin" : true | false
}
Réponse
{
"pid" : <integer>,
"userId": <integer>,
"username" : <string>,
"status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
"firstName" : <string>,
"lastName" : <string>,
"email" : <string>,
"title" : <string_may_be_null>,
"phoneNumber" : <string_may_be_null>,
"groups" : [<group_1_id>, ...],
"isAdmin" : <"true"|"false">
}
Si isAdmin
est défini sur true, l’utilisateur est créé en tant qu’administrateur de partenaire. Cette propriété vous permet également de savoir si un utilisateur est un administrateur de partenaire.
Renvoie 409 Conflict
si le nom d’utilisateur est déjà utilisé.
Mettre à jour un utilisateur update-user
Une méthode PUT
pour mettre à jour un utilisateur.
Demande
PUT /api/v1/users/
<userId>
Exemple de corps de requête
{
"username" : <string>,
"status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
"firstName" : <string>,
"lastName" : <string>,
"email" : <string>,
"title" : <string_may_be_null>,
"phoneNumber" : <string_may_be_null>,
"groups" : [<group_1_id>, ...]
}
Réponse
{
"pid" : <integer>,
"userId": <integer>,
"username" : <string>,
"status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
"firstName" : <string>,
"lastName" : <string>,
"email" : <string>,
"groups" : [<group_1_id>, ...]
}
Renvoie 409 Conflict
si le nom d’utilisateur est déjà utilisé.
Mettre à jour l’utilisateur connecté update-logged-in-user
Une méthode PUT
pour mettre à jour l’utilisateur actuellement connecté.
Demande
PUT /self/update
Exemple de corps de requête
{
"status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
"firstName" : <string>,
"lastName" : <string>,
"email" : <string>,
"title" : <string_may_be_null>,
"phoneNumber" : <string_may_be_null>
}
Réponse
{
"userId": <integer>,,
"status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
"firstName" : <string>,
"lastName" : <string>,
"email" : <string>
"title" : <string_may_be_null>,
"phoneNumber" : <string_may_be_null>
}
Renvoie 409 Conflict
si le nom d’utilisateur est déjà utilisé.
Mettre à jour le mot de passe utilisateur connecté update-logged-in-user-pw
Une méthode PUT
pour mettre à jour l’utilisateur actuellement connecté.
Demande
POST /users/self/update-password
Exemple de corps de requête
{ "oldPassword" : "old password", "newPassword" : "new password" }
Renvoie 200 OK
en cas de réussite. Renvoie 400 Bad Request
si un problème est survenu avec l’un des mots de passe.
Réinitialisation du mot de passe utilisateur connecté reset-logged-in-user-pw
Une méthode PUT
pour réinitialiser l’utilisateur actuellement connecté. Audience Management envoie à l’utilisateur un mot de passe généré par le système.
Demande
POST /self/reset-password
Renvoie 200 OK
en cas de réussite.
Renvoie l’objet utilisateur d’un ID utilisateur return-user-object-for-id
Une méthode Get
pour renvoyer l’objet utilisateur d’un ID utilisateur.
Demande
GET /api/v1/users/
<userId>
Réponse
{
"pid" : <integer>,
"userId": <integer>,
"username" : <string>,
"status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
"firstName" : <string>,
"lastName" : <string>,
"email" : <string>,
"title" : <string_may_be_null>,
"phoneNumber" : <string_may_be_null>,
"groups" : [<groupd_id_1>, ...]
}
Objet utilisateur de retour pour l’utilisateur connecté return-user-object-for-logged-in-user
Une méthode Get
pour renvoyer l’objet utilisateur pour l’utilisateur actuellement connecté.
Demande
GET /api/v1/users/self
Réponse
{
"pid" : <integer>,
"userId": <integer>,
"username" : <string>,
"status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
"firstName" : <string>,
"lastName" : <string>,
"email" : <string>,
"title" : <string_may_be_null>,
"phoneNumber" : <string_may_be_null>,
"groups" : [<groupd_id_1>, ...]
}
Répertorier les utilisateurs list-users
Une méthode GET
pour répertorier les utilisateurs.
Demande
GET /api/v1/users/
Vous pouvez spécifier plusieurs ID de groupe dans les paramètres de requête :
GET /api/v1/users/?groupId=343&groupdId=12
Cette requête renvoie une liste de tous les utilisateurs des groupes spécifiés.
Réponse
{
"pid" : <integer>,
"userId": <integer>,
"username" : <string>,
"status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
"firstName" : <string>,
"lastName" : <string>,
"email : <string>,
"title" : <string_may_be_null>,
"phoneNumber" : <string_may_be_null>,
"groups" : [<group_1_id>, ...]
}
Suppression d’un utilisateur delete-users
Une méthode DELETE
pour supprimer un utilisateur.
Demande
DELETE /api/v1/users/
<user_id>
Renvoie 204 No Content
en cas de réussite. En cas de conflit, renvoie 409 Conflict
.
Suppression d’utilisateurs en bloc delete-users-bulk
Une méthode POST
pour supprimer plusieurs utilisateurs en bloc.
Demande
POST /api/v1/users/bulk-delete
Exemple de corps de requête
{[<user_id_1>, <user_id_2>, ...]}