Update User

Updates a specific user accounts. You can pass in a query param action that will accept the following values:

  • updatePassword updates user password. See table below for payload requirements.
  • enableAuthy adds a new domain provided in the payload. See table below for payload requirements.

Body: raw JSON

The following fields are required if action=updatePassword query param is used. Other updatable fields will be ignored if provided.

namedescription
oldPassword[string] Required. User's old password
password[string] Required. User's new password

The following fields are required if action=enableAuthy query param is used. Other updatable fields will be ignored if provided.

namedescription
authyPhoneNumber[string] Required. User's Authy phone number
authyPhoneCountryCode[string] Required. Country code for the authyPhoneNumber
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ZUID of the user to update

Query Params
string

Optional. Acceptable values are updatePassword, enableAuthy and disableAuthy.

Body Params

User object to update

string | null
string | null

Required and applicable only if action=enableAuthy is used.

string | null

Required and applicable only if action=enableAuthy is used.

string | null
string | null
string | null
string

Required and applicable only if action=updatePassword is used.

string | null

Required and applicable only if action=updatePassword is used.

prefs
object | null
Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json