API-methoden voor gebruikersbeheer user-management-api-methods

Stel API -methoden in om gebruikers te beheren, zoals het maken, bijwerken, aanbieden, verwijderen en retourneren van gebruikersobjecten.

Een gebruiker maken create-user

Een methode POST om een nieuwe gebruiker te maken.

Verzoek

POST /api/v1/users/

Voorbeeld van aanvraaginstantie

{
  "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
}

Antwoord

{
  "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">

}

Als isAdmin aan waar wordt geplaatst, wordt de gebruiker gecreeerd als partner admin. Dit bezit laat u ook weten of een gebruiker een partner admin is.

Retourneert 409 Conflict als de gebruikersnaam al in gebruik is.

Een gebruiker bijwerken update-user

Een PUT -methode om een gebruiker bij te werken.

Verzoek

PUT /api/v1/users/<userId>

Voorbeeld van aanvraaginstantie

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

Antwoord

{
  "pid" : <integer>,
  "userId": <integer>,
  "username" : <string>,
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
  "firstName" : <string>,
  "lastName" : <string>,
  "email" : <string>,
  "groups" : [<group_1_id>, ...]

}

Retourneert 409 Conflict als de gebruikersnaam al in gebruik is.

Gebruiker met aanmelding bijwerken update-logged-in-user

Een PUT -methode om de momenteel aangemelde gebruiker bij te werken.

Verzoek

PUT /self/update

Voorbeeld van aanvraaginstantie

{
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
  "firstName" : <string>,
  "lastName" : <string>,
  "email" : <string>,
  "title" : <string_may_be_null>,
  "phoneNumber" : <string_may_be_null>
}

Antwoord

{
  "userId": <integer>,,
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
  "firstName" : <string>,
  "lastName" : <string>,
  "email" : <string>
  "title" : <string_may_be_null>,
  "phoneNumber" : <string_may_be_null>
}

Retourneert 409 Conflict als de gebruikersnaam al in gebruik is.

Aangemeld gebruikerswachtwoord bijwerken update-logged-in-user-pw

Een PUT -methode om de momenteel aangemelde gebruiker bij te werken.

Verzoek

POST /users/self/update-password

Voorbeeld van aanvraaginstantie

{ "oldPassword" : "old password", "newPassword" : "new password" }

Retourneert 200 OK indien gelukt. Retourneert 400 Bad Request als er iets mis is met een van beide wachtwoorden.

Wachtwoord aangemelde gebruiker opnieuw instellen reset-logged-in-user-pw

Een PUT -methode om de momenteel aangemelde gebruiker opnieuw in te stellen. Audience Management stuurt de gebruiker een door het systeem gegenereerd wachtwoord.

Verzoek

POST /self/reset-password

Retourneert 200 OK indien gelukt.

Gebruikersobject retourneren voor een gebruikersnaam return-user-object-for-id

Een Get -methode om het gebruikersobject voor een gebruiker-id te retourneren.

Verzoek

GET /api/v1/users/<userId>

Antwoord

{
  "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>, ...]

}

Gebruikersobject retourneren voor aangemelde gebruiker return-user-object-for-logged-in-user

Een Get -methode om het gebruikersobject te retourneren voor de momenteel aangemelde gebruiker.

Verzoek

GET /api/v1/users/self

Antwoord

{
  "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>, ...]

}

Lijstgebruikers list-users

Een GET -methode om gebruikers weer te geven.

Verzoek

GET /api/v1/users/

U kunt veelvoudige groep IDs in de vraagparameters specificeren:

GET /api/v1/users/?groupId=343&groupdId=12

Deze query retourneert een lijst met alle gebruikers in de opgegeven groepen.

Antwoord

{
  "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>, ...]

}

Een gebruiker verwijderen delete-users

Een methode DELETE om een gebruiker te verwijderen.

Verzoek

DELETE /api/v1/users/<user_id>

Retourneert 204 No Content indien gelukt. In het geval van conflictoplossingen 409 Conflict .

Gebruikers in bulk verwijderen delete-users-bulk

Een POST -methode om meerdere gebruikers in bulk te verwijderen.

Verzoek

POST /api/v1/users/bulk-delete

Voorbeeld van aanvraaginstantie

{[<user_id_1>, <user_id_2>, ...]}