Update an existing user.

put

https://example.com/user-profile/v1/users/{id}

Updates an existing user and returns the updated user object.
User roles: admin

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The unique internal identifier of the entity that should be processed

Body Params

The existing user object is replaced by the given object. Some fields will be ignored.

The user object that might be sent to replace the user. The fields id, externalId, links, created, creator, lastModified, and lastModifier will be ignored.

string

required

The unique internal identifier of the user

externalId

string

length ≤ 512

The unique external identifier of the user (e.g. BlueID). Although, this field can store email addresses, other types of unique identifiers may be stored too. Do not use this field as a replacement for the user attribute email address.

firstName

string

length ≤ 512

The first name of the user

lastName

string

length ≤ 512

The last name of the user

uid

string

length ≤ 30

Acoustic Id of the user, if not present during POST call an Acoustic Id will be created for the user

displayName

string

length ≤ 512

The name of the user that can be displayed in the UI

string

length ≤ 512

The email of the user that can be displayed in the UI

roles

array of strings

length between 1 and 1

The roles of the user that will be used for access control

links

object

created

date-time

Date when this item was created

creator

object

URI pointing to the User who has created the item

lastModified

date-time

Date when this item was modified for the last time

lastModifier

object

URI pointing to the User who has modified the item

Responses

404

The given ID cannot be resolved.

200The user was updated successfully.

400Response indicating a client error.

429Too Many Requests, the server has reached a limit, the request must be sent again at a later time.