v1

latestSwagger 2.02026-07-14172228.6 KB
Users

Replace User

Changes an existing user's displayName, locale, timezone, username and password. The request must include the full user definition (to modify one or more values without sending the full definition, see Update User). The replaced user email domain must be an existing organization email domain.

put/Users/{userKey}

Path parameters

userKeyinteger required

The key of the user to query. The user must be in the organization domain

Headers

Authorizationstring required

Access token prefixed with 'Bearer ', e.g. 'Bearer 123456abcdef'

Request body

displayNamestring

The user's display name

localestring

The user's language settings

passwordstring

The user's password

timezonestring

The user's time zone

userNamestring

The user's username, usually their email address

Response

The user has been replaced.

displayNamestring required

The user's display name

idstring required

The user's unique key

localestring required

The user's language settings

timezonestring required

The user's time zone

userNamestring required

The user's username, usually their email address