Update User

patch https://example.com/ums/v2/users/{id}

Update User

Performs partial update, if a field is specified in the request it will be updated

(*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information.

Request Body Parameters:

Parameter	Type	Mandatory	Description	Example
username	string	false	user's username. If the credential type is OTP, should be a valid phone (An E.164 formatted phone number e.g +12345678901)
locked	boolean	false
active	boolean	false
groupIds	array	false
idPs	array	false
mfa	object	false
mfa.enabled	boolean	true(*)
mfa.phone	string	true(*)	An E.164 formatted phone number	+12345678901
mfa.expirationInMinutes	integer	false
Path Parameters:

Parameter	Type	Mandatory	Description	Example
id	string	true	User ID that needs to be updated	3fa85f64-5717-4562-b3fc-2c963f66afa6

This API requires UMS_USERS_UPDATE_USER permission(s).

Language

Credentials

Bearer

JWT

Click Try It! to start a request and see the response here!