Méthodes d’API de gestion des utilisateurs

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.

Créer un utilisateur

Méthode POST permettant de 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 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é.

Mettre à jour un utilisateur

Méthode PUT permettant de 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é

Méthode PUT pour mettre à jour l’utilisateur actuellement connecté.

REMARQUE

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.

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é

Méthode PUT pour mettre à jour l’utilisateur actuellement connecté.

REMARQUE

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.

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 survient avec l'un des mots de passe.

Réinitialiser le mot de passe utilisateur connecté

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.

REMARQUE

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.

Demande

POST /self/reset-password

Renvoie 200 OK en cas de réussite.

Renvoie un objet utilisateur pour un ID utilisateur

Méthode Get pour renvoyer l’objet utilisateur pour 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>, ...] 
 
}

Renvoie l’objet utilisateur pour l’utilisateur connecté

Méthode Get pour renvoyer l’objet utilisateur pour l’utilisateur actuellement connecté.

REMARQUE

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.

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>, ...] 
 
}

Utilisateurs de liste

Méthode GET destinée aux utilisateurs de la liste.

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>, ...] 
 
}

Supprimer un utilisateur

Méthode DELETE de suppression d’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.

Supprimer des utilisateurs en bloc

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>, ...]}

Sur cette page