Update the specified user.
patch
/social/api/v1/people/{peopleID}
Request
Supported Media Types
- application/json
Path Parameters
-
peopleID: integer(int64)
The people ID. The object's unique identifier from a long integer representation.
The request body defines the details of the request.
Root Schema : XV1PeopleUpdateInfo
Type:
objectV1 People Update Information.
Show Source
-
profileUpdater:
object XUserProfileUpdater
Updater for user profiles.
-
updater:
object XUserUpdater
Updater for user objects.
IMPORTANT: The following updater fields are supported only by the XUserModule.Server.updateUser() method. They are not supported by the XUserObject.updateAttributes() method. XUserObject clients must call the individual setters instead (see setAdmin(), setEnabled(), and so on).
See XUserProfileUpdater for additional user-related fields that are updatable through an XUpdater (title, phone number, and so on).
Nested Schema : XUserProfileUpdater
Type:
objectUpdater for user profiles.
Show Source
-
ADDRESS_BUILDING:
string
String for the user's address building.
-
ADDRESS_CITY:
string
String for the user's address city.
-
ADDRESS_COUNTRY:
string
String for the user's address country.
-
ADDRESS_LINE_1:
string
String for the user's address line 1.
-
ADDRESS_LINE_2:
string
String for the user's address line 2.
-
ADDRESS_OFFICE:
string
String for the user's address office.
-
ADDRESS_STATE:
string
String for the user's address state.
-
ADDRESS_ZIP_CODE:
string
String for the user's address ZIP Code.
-
ALTITUDE:
string
Double for the altitude.
-
BIOGRAPHY:
string
String for the user's biography.
-
COLOR:
string
The user's color.
-
COMPANY:
string
String for the user's company.
-
COST_CENTER:
string
String for the user's cost center.
-
CUSTOM_FIELDS:
string
Collection of all custom fields.
-
DATE_FORMAT_LOCALE:
string
The user's date format locale.
-
DESCRIPTION:
string
String for the user's description.
-
EMAIL_ADDRESS:
string
The user's email address.
-
EXPERTISE:
string
String for the user's expertise.
-
fMap:
string
The contained Map of Strings to Values.
-
FULL_NAME:
string
The user's full name (for example, 'John Doe'). This can be used to generate a DisplayName value.
-
INTERESTS:
string
String for the user's interests.
-
LANGUAGE_LOCALE:
string
The user's locale.
-
LATITUDE:
string
Double for the latitude.
-
LATITUDE_MAX:
number(double)
Maximum allowed latitude.
-
LATITUDE_MIN:
number(double)
Minimum allowed latitude.
-
LINK:
string
Map of all links with name (String) to link (String).
-
LINKS:
string
Map of all links with name (String) to link (String).
-
LOCATION:
string
String for the user's location.
-
LOCATIONS:
string
Map of all links with name (String) to time zone (TimeZone).
-
LONGITUDE:
string
Double for the longitude.
-
LONGITUDE_MAX:
number(double)
Maximum allowed longitude.
-
LONGITUDE_MIN:
number(double)
Minimum allowed longitude.
-
MANAGER:
string
The user's manager.
-
OFFLINE_STATUS_MESSAGE:
string
The user's offline status message.
-
ONLINE_STATUS_MESSAGE:
string
The user's online status message.
-
ORGANIZATION:
string
String for the user's organization.
-
PHONE_NUMBER:
string
The phone number for this user. Use this or PHONE_NUMBERS but not both. It replaces all phone numbers. This field is used only from LDAP sync and Create User code. This field sets all phone numbers to one number. This field is not used much anymore, except for the stated purposes.
-
PHONE_NUMBERS:
string
Collection of XUserPhoneNumberInfo with all phone numbers. Use this or PHONE_NUMBER but not both. It replaces all phone numbers. This is the correct field to use to alter all phone numbers.
-
RTC_SERVERS:
string
RTC Servers. The type for this field is a list of XUserRTCServerInfo objects.
-
SHOW_MEMBERSHIP_MESSAGES_DEFAULT:
string
Boolean for the default show membership messages status for conversations this user enters.
-
SMS_ADDRESS:
string
The SMS address for this user.
-
SOCIAL_OBJECT_VIEW_ID:
string
The view ID for collaboration objects.
-
STATUS:
string
String for the user's status.
-
TAGS:
string
Collection containing (String) tags to add.
-
TIME_ZONE:
string
The user's default time zone.
-
TITLE:
string
String for the user's title.
Nested Schema : XUserUpdater
Type:
objectUpdater for user objects.
Show Source
IMPORTANT: The following updater fields are supported only by the XUserModule.Server.updateUser() method. They are not supported by the XUserObject.updateAttributes() method. XUserObject clients must call the individual setters instead (see setAdmin(), setEnabled(), and so on).
See XUserProfileUpdater for additional user-related fields that are updatable through an XUpdater (title, phone number, and so on).
-
ACT_ON_BEHALF_OF:
string
Boolean for act-on-behalf-of status.
-
ADMIN:
string
Boolean for site admin status.
-
APPAUTHOR:
string
Boolean for app author status.
-
APPID:
string
Boolean for app ID status.
-
BYPASS:
string
Boolean for bypass status.
-
CAN_CREATE_CONVERSATION:
string
Boolean for whether the user can create conversations.
-
CAN_DISCOVER:
string
Boolean for whether the user can discover.
-
CLIENTAPP:
string
Boolean for Client APP status.
-
DELETED:
string
Boolean for deleted status.
-
DEVELOPER:
string
Boolean for developer status.
-
ENABLED:
string
Boolean for enabled status.
-
fMap:
string
The contained Map of Strings to Values.
-
GUEST:
string
Boolean for guest status.
-
HIDDEN:
string
Boolean for hidden status.
-
INTEGRATIONUSER:
string
Boolean for integration status.
-
INTERNAL:
string
Boolean for internal realm authority (versus external configured realm).
-
IS_ON_LEGAL_HOLD:
string
Boolean for legal hold.
-
LEGALDISCOVERER:
string
Boolean for legal discoverer status.
-
LOCKED:
string
Boolean for locked status.
-
MAIL_IMPORTER_ID:
string
Long for the mail importer ID.
-
NAME:
string
String for name.
-
OUTSIDER:
string
Boolean for outsider status.
-
REALM_DATA:
string
String for the realm data.
-
REALM_UID:
string
String for the realm unique ID.
-
RESTRICTED:
string
Boolean for restricted status.
-
RETENTION_EXTENDED:
string
Boolean for whether this user uses the extended retention policy.
-
TENANT:
string
Boolean for tenant admin status.
-
VERIFIED:
string
Boolean for whether the user has been verified or not.
Response
Supported Media Types
- application/json
200 Response
Successful operation.
V1 People Information DTO.
Root Schema : XV1PeopleInfo
Type:
objectV1 People Information DTO.
Show Source
-
addressBuilding:
string
This user's building.
-
addressCity:
string
This user's city.
-
addressCountry:
string
This user's country.
-
addressLine1:
string
This user's street address.
-
addressLine2:
string
This user's street address second line.
-
addressOffice:
string
This user's office.
-
addressState:
string
This user's state.
-
addressZipCode:
string
This user's ZIP Code.
-
altitude:
number(double)
The object's altitude.
-
biography:
string
The biography for this user.
-
chatURL:
string(url)
A URL specifying this user's one-on-one conversation with the current user.
-
collectionURL:
string(url)
A URL to this object's containing collection.
-
company:
string
This user's company.
-
conversationURL:
string(url)
A URL to this object's containing conversation.
-
costCenter:
string
This user's cost center.
-
createdByID:
An object's unique identifier from a long integer representation.
-
createdByURL:
string(url)
A URL to the user that created this object.
-
createdByUserDisplayName:
string
The display name of the user that created this object.
-
createdByUserName:
string
The name of the user that created this object.
-
createdDate:
string(date)
The date this object was created.
-
createdDateInISO8601Format:
string
The date this object was created, in ISO 8601 format.
-
dateFormatLocale:
string(uuid)
This user's locale for formatting dates.
-
description:
string
The user profile description.
-
displayName:
string
The display name of this object.
-
eMailAddress:
string
The email address for this user.
-
expertise:
string
This user's expertise.
-
followersURL:
string(url)
This user's followers URL. Users that are followers of this user.
-
followingURL:
string(url)
This user's following URL. Users that this user is following.
-
fullName:
string
The full name for this user.
-
id:
An object's unique identifier from a long integer representation.
-
interests:
string
This user's interests.
-
isDeleted:
boolean
True if this user is deleted.
-
isEnabled:
boolean
True if this user is enabled.
-
isHidden:
boolean
True if the user is to be hidden.
-
isIntegrationUser:
boolean
True if the user is an integration user.
-
isInternal:
boolean
True if the user is internal, false if the user is external.
-
isOutsider:
boolean
True if the user is an outsider.
-
isRemoved:
boolean
True if this message has been removed.
-
languageLocale:
string(uuid)
This user's language locale.
-
lastConnectedDate:
string(date)
The date this user last connected.
-
lastConnectedDateInISO8601Format:
string
The date this user last connected, in ISO 8601 format.
-
lastDisconnectedDate:
string(date)
The date this user last disconnected.
-
lastDisconnectedDateInISO8601Format:
string
The date this user last disconnected, in ISO 8601 format.
-
latitude:
number(double)
The object's latitude.
-
libraryURL:
string(url)
A URL specifying this user's library.
-
link:
string
A URL, if any, that this user shows on their wall or profile as their link.
-
location:
string
This user's location.
-
longitude:
number(double)
The object's longitude.
-
modifiedByID:
An object's unique identifier from a long integer representation.
-
modifiedByURL:
string(url)
A URL to the user that last modified this object.
-
modifiedByUserDisplayName:
string
The display name of the user that last modified this object.
-
modifiedByUserName:
string
The name of the user that last modified this object.
-
modifiedDate:
string(date)
The date this object was last modified.
-
modifiedDateInISO8601Format:
string
The date this object was last modified, in ISO 8601 format.
-
name:
string
The name of this object.
-
objectType:
string
The type of this object.
-
organization:
string
This user's organization.
-
originalPictureURL:
string(url)
The original picture URL.
-
profilePictureURL:
string(url)
The profile picture URL (150 px by 150 px).
-
propertiesURL:
string(url)
This user's properties URL.
-
removedByID:
An object's unique identifier from a long integer representation.
-
removedByURL:
string(url)
A URL to the user that last removed this object.
-
removedByUserDisplayName:
string
The display name of the user that last removed this object.
-
removedByUserName:
string
The name of the user that last removed this object.
-
removedDate:
string(date)
The date this object was removed.
-
removedDateInISO8601Format:
string
The date this object was removed, in ISO 8601 format.
-
scaledPictureURL:
string(url)
The scaled picture URL (44 px by 44 px).
-
socialObjectURL:
string(url)
A URL to this object's containing collaboration object.
-
socialObjectViewID:
string
The user's current collaboration object view ID (can be null).
-
statisticsURL:
string(url)
A URL to retrieve this user's statistics.
-
timeZone:
string(uuid)
This user's time zone.
-
title:
string
This user's title.
-
url:
string(url)
A URL to this object.
-
wallURL:
string(url)
A URL specifying this user's wall.