Update a user

Prev Next
Put
/identity/users/{userId}

Update a user

Required permissions: READ_USER, WRITE_USER.
Optional permissions: READ_USER_PERMISSIONS, WRITE_USER_PERMISSIONS, WRITE_USER_STATUS, WRITE_USER_NOTIFICATION_SETTINGS.

Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired

The name of the target tenant (e.g. acme).

Path parameters
userId
stringRequired

The id fo the user to update.

Minimum1.0
Exampleabcd1234
Body parameters

The details of user being updated.

object

The bean providing user details.

email
string

The user registration email address.

firstName
string

The user first name.

lastName
string

The user last name.

organizationId
string

The organization identifier the user belong to (required only for creation).

partnerId
string

The partner identifier the user belong to (required only for creation).

customerId
string

The customer identifier the user belong to (required only for creation).

locationId
string

The location identifier the user belong to (required only for creation).

timezone
string

The timezone used for date/times localization (e.g. Europe/Rome).

language
string

The language used for page localization (e.g. EN, ES).

creationTimestamp
integer (int64)

The timestamp at which the object was created.

alertActivatedInformationalEmailEnabled
boolean

The flag indicating whether an email must be sent on informational alert activation.

alertClearedInformationalEmailEnabled
boolean

The flag indicating whether an email must be sent on informational alert clearing.

alertActivatedWarningEmailEnabled
boolean

The flag indicating whether an email must be sent on warning alert activation.

alertClearedWarningEmailEnabled
boolean

The flag indicating whether an email must be sent on warning alert clearing.

alertActivatedFailureEmailEnabled
boolean Deprecated

The flag indicating whether an email must be sent on failure alert activation.

alertClearedFailureEmailEnabled
boolean Deprecated

The flag indicating whether an email must be sent on failure alert clearing.

alertActivatedCriticalEmailEnabled
boolean

The flag indicating whether an email must be sent on critical alert activation.

alertClearedCriticalEmailEnabled
boolean

The flag indicating whether an email must be sent on critical alert clearing.

alertActivatedEmergencyEmailEnabled
boolean

The flag indicating whether an email must be sent on emergency alert activation.

alertClearedEmergencyEmailEnabled
boolean

The flag indicating whether an email must be sent on emergency alert clearing.

alertActivatedInformationalSmsEnabled
boolean

The flag indicating whether an SMS must be sent on informational alert activation.

alertClearedInformationalSmsEnabled
boolean

The flag indicating whether an SMS must be sent on informational alert clearing.

alertActivatedWarningSmsEnabled
boolean

The flag indicating whether an SMS must be sent on warning alert activation.

alertClearedWarningSmsEnabled
boolean

The flag indicating whether an SMS must be sent on warning alert clearing.

alertActivatedFailureSmsEnabled
boolean Deprecated

The flag indicating whether an SMS must be sent on failure alert activation.

alertClearedFailureSmsEnabled
boolean Deprecated

The flag indicating whether an SMS must be sent on failure alert clearing.

alertActivatedCriticalSmsEnabled
boolean

The flag indicating whether an SMS must be sent on critical alert activation.

alertClearedCriticalSmsEnabled
boolean

The flag indicating whether an SMS must be sent on critical alert clearing.

alertActivatedEmergencySmsEnabled
boolean

The flag indicating whether an SMS must be sent on emergency alert activation.

alertClearedEmergencySmsEnabled
boolean

The flag indicating whether an SMS must be sent on emergency alert clearing.

alertActivatedInformationalPushEnabled
boolean

The flag indicating whether an push notification must be sent on informational alert activation.

alertClearedInformationalPVoicenabled
boolean

The flag indicating whether an push notification must be sent on informational alert clearing.

alertActivatedWarningPushEnabled
boolean

The flag indicating whether an push notification must be sent on warning alert activation.

alertClearedWarningPushEnabled
boolean

The flag indicating whether an push notification must be sent on warning alert clearing.

alertActivatedFailurePushEnabled
boolean Deprecated

The flag indicating whether an push notification must be sent on failure alert activation.

alertClearedFailurePushEnabled
boolean Deprecated

The flag indicating whether an push notification must be sent on failure alert clearing.

alertActivatedCriticalPushEnabled
boolean

The flag indicating whether an push notification must be sent on critical alert activation.

alertClearedCriticalPushEnabled
boolean

The flag indicating whether an push notification must be sent on critical alert clearing.

alertActivatedEmergencyPushEnabled
boolean

The flag indicating whether an push notification must be sent on emergency alert activation.

alertClearedEmergencyPushEnabled
boolean

The flag indicating whether an phone call must be made on emergency alert clearing.

alertActivatedInformationalVoiceEnabled
boolean

The flag indicating whether an phone call must be made on informational alert activation.

alertClearedInformationalVoiceEnabled
boolean

The flag indicating whether an phone call must be made on informational alert clearing.

alertActivatedWarningVoiceEnabled
boolean

The flag indicating whether an phone call must be made on warning alert activation.

alertClearedWarningVoiceEnabled
boolean

The flag indicating whether an phone call must be made on warning alert clearing.

alertActivatedFailureVoiceEnabled
boolean Deprecated

The flag indicating whether an phone call must be made on failure alert activation.

alertClearedFailureVoiceEnabled
boolean Deprecated

The flag indicating whether an phone call must be made on failure alert clearing.

alertActivatedCriticalVoiceEnabled
boolean

The flag indicating whether an phone call must be made on critical alert activation.

alertClearedCriticalVoiceEnabled
boolean

The flag indicating whether an phone call must be made on critical alert clearing.

alertActivatedEmergencyVoiceEnabled
boolean

The flag indicating whether an phone call must be made on emergency alert activation.

Responses
200

Successful updated.

400

Request data not valid.

object
message
string

The error response.

ExampleBad request
401

User not authenticated.

object
message
string

The error response.

ExampleUser not authenticated
403

User not authorized.

object
message
string

The error response.

ExampleUser not authorized
404

Resource was not found.

object
message
string

The error response.

ExampleResource not found
429

API call rate limit exeeded.

object
message
string

The error response.

ExampleAPI call rate limit exeeded
500

Internal server error.

object
message
string

The error response.

ExampleInternal Server Error