User GuideAPI Reference
ProductUse CasesResource CenterFAQAbout UsBook a DemoSign Up - It's Free
API Reference

Update User

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:

ParameterTypeMandatoryDescriptionExample
usernamestringfalseuser's username. If the credential type is OTP, should be a valid phone (An E.164 formatted phone number e.g +12345678901)
lockedbooleanfalse
activebooleanfalse
groupIdsarrayfalse
idPsarrayfalse
mfaobjectfalse
mfa.enabledbooleantrue(*)
mfa.phonestringtrue(*)An E.164 formatted phone number+12345678901
mfa.expirationInMinutesintegerfalse

Path Parameters:

ParameterTypeMandatoryDescriptionExample
idstringtrueUser ID that needs to be updated3fa85f64-5717-4562-b3fc-2c963f66afa6

This API requires UMS_USERS_UPDATE_USER permission(s).

Language
Authorization
Bearer
JWT
Click Try It! to start a request and see the response here!