Restez API aux méthodes de gestion des utilisateurs, y compris la création, la mise à jour, la liste, la suppression et le renvoi d’objets utilisateur.
Méthode POST
permettant de créer un utilisateur.
POST /api/v1/users/
{
"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
}
{
"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 partenaire. Cette propriété vous permet également de savoir si un utilisateur est un administrateur partenaire.
Renvoie 409 Conflict
si le nom d'utilisateur est déjà utilisé.
Méthode PUT
permettant de mettre à jour un utilisateur.
PUT /api/v1/users/
<userId>
{
"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>, ...]
}
{
"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é.
Méthode PUT
pour mettre à jour l’utilisateur actuellement connecté.
Alors que la plupart des méthodes API ne sont appelables que par les administrateurs partenaires, cette méthode est appelable par les utilisateurs non-administrateurs.
PUT /self/update
{
"status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
"firstName" : <string>,
"lastName" : <string>,
"email" : <string>,
"title" : <string_may_be_null>,
"phoneNumber" : <string_may_be_null>
}
{
"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é.
Méthode PUT
pour mettre à jour l’utilisateur actuellement connecté.
Alors que la plupart des méthodes API ne sont appelables que par les administrateurs partenaires, cette méthode est appelable par les utilisateurs non-administrateurs.
POST /users/self/update-password
{ "oldPassword" : "old password", "newPassword" : "new password" }
Renvoie 200 OK
en cas de réussite. Renvoie 400 Bad Request
si un problème survient avec l'un des mots de passe.
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.
Alors que la plupart des méthodes API ne sont appelables que par les administrateurs partenaires, cette méthode est appelable par les utilisateurs non-administrateurs.
POST /self/reset-password
Renvoie 200 OK
en cas de réussite.
Méthode Get
pour renvoyer l’objet utilisateur pour un ID utilisateur.
GET /api/v1/users/
<userId>
{
"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>, ...]
}
Méthode Get
pour renvoyer l’objet utilisateur pour l’utilisateur actuellement connecté.
Alors que la plupart des méthodes API ne sont appelables que par les administrateurs partenaires, cette méthode est appelable par les utilisateurs non-administrateurs.
GET /api/v1/users/self
{
"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>, ...]
}
Méthode GET
destinée aux utilisateurs de la liste.
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.
{
"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>, ...]
}
Méthode DELETE
de suppression d’un utilisateur.
DELETE /api/v1/users/
<user_id>
Renvoie 204 No Content
en cas de réussite. En cas de conflit renvoie 409 Conflict
.
Une méthode POST
pour supprimer plusieurs utilisateurs en bloc.
POST /api/v1/users/bulk-delete
{[<user_id_1>, <user_id_2>, ...]}