Update an existing connection.
put
/social/api/v1/connections
Request
Supported Media Types
- application/json
The request body defines the details of the request.
Root Schema : XV1ConnectionUpdateInfo
Type:
object
V1 Connection Update Information.
Show Source
-
isImpersonate(optional):
boolean
Set or unset impersonate using the specified name.
-
isImpersonateEx(optional):
boolean
Set or unset impersonate using the specified name. Also uses the fields realmID and sendInvitation.
-
isOnBehalfOf(optional):
boolean
Set or unset on-behalf-of using the specified name.
-
isOnBehalfOfEx(optional):
boolean
Set or unset on-behalf-of using the specified name. Also uses the fields realmID and sendInvitation.
-
isTerseMode(optional):
boolean
The session's response mode. In terse mode, fields will not be included in the response if they hold a boolean 'false' or an integer or long 'zero' value.
-
name(optional):
string
The user name.
-
realmID(optional):
An object's unique identifier from a long integer representation.
-
sendInvitation(optional):
boolean
The user name's send invitation option. Used for isOnBehalfOfEx or isImpersonateEx only.
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : XV1ConnectionInfo
Type:
object
V1 Conversation Property Information DTO.
Show Source
-
analyticsURL(optional):
string
Analytics URL.
-
apiRandomID(optional):
string
A random ID that should be sent along with all API requests in a header 'X-Waggle-RandomID'.
-
apiVersion(optional):
integer(int32)
The current API version of the API accepted by the server.
-
apiVersionMinimum(optional):
integer(int32)
The minimum API version of the API accepted by the server.
-
backChannelHost(optional):
string
Back-channel access host.
-
backChannelPath(optional):
string
Back-channel access path.
-
backChannelServletName(optional):
string
Back-channel access servlet name.
-
backChannelURL(optional):
string
Back-channel access URL.
-
clientAdminURL(optional):
string
Client admin URL.
-
clientDownloadURL(optional):
string
Outlook or Desktop Client download URL.
-
clientDownloadURL_Android(optional):
string
Android Client download URL.
-
clientDownloadURL_Desktop(optional):
string
Desktop Client download URL.
-
clientDownloadURL_iOS(optional):
string
iOS Client download URL.
-
clientDownloadURL_Outlook(optional):
string
Outlook Client download URL.
-
clientHelpURL(optional):
string
Client help URL.
-
clientUpdateURL(optional):
string
Outlook or Desktop Client update URL.
-
clientUpdateURL_Desktop(optional):
string
Desktop Client update URL.
-
clientUpdateURL_Outlook(optional):
string
Outlook Client update URL.
-
communityURL(optional):
string
The community URL.
-
contextName(optional):
string
Front-channel or back-channel access context name.
-
contextURL(optional):
string
Front-channel or back-channel access context base URL.
-
dateFormatLocale(optional):
string
The locale that clients should use to format dates for the user. This locale is inferred by the server based on the user's profile, the HTTP accept-language header, the application configuration, the host machine setting, and the available translation bundles. The date-format locale will have the same primary language as the Translation Bundle locale, but might not be an exact match of one of the officially supported translations. The reason for this is to allow more specialized date-format locales, such as 'en_US' or 'en_GB', when the Translation Bundle locale is simply 'en'.
-
externalMobileClientURL(optional):
string
External Mobile Client URL.
-
externalWebClientURL(optional):
string
External Web Client URL.
-
federatedSSOApplicationName(optional):
string
Mobile Client Federated SSO Application Name.
-
federatedSSOEnabled(optional):
boolean
Mobile Client Federated SSO enabled status.
-
federatedSSOLoginFailureURL(optional):
string
Mobile Client Federated SSO Login Failure URL.
-
federatedSSOLoginSuccessURL(optional):
string
Mobile Client Federated SSO Login Success URL.
-
federatedSSOLoginURL(optional):
string
Mobile Client Federated SSO Login URL.
-
federatedSSOLogoutURL(optional):
string
Mobile Client Federated SSO Logout URL.
-
federatedSSORequiredTokens(optional):
string
Mobile Client Tokens.
-
flagAllLimitHard(optional):
integer(int32)
Flag all users hard limit.
-
flagAllLimitSoft(optional):
integer(int32)
Flag all users soft limit.
-
frontChannelHost(optional):
string
Front-channel access host.
-
frontChannelPath(optional):
string
Front-channel access path.
-
frontChannelServletName(optional):
string
Front-channel access servlet name.
-
frontChannelURL(optional):
string
Front-channel access URL.
-
hiveGUID(optional):
string
The hive GUID, which is unique across all instances.
-
hiveHash(optional):
string
The hive hash, which is unique across all instances. This is the first 4 characters of the hiveGUID.
-
isAppAuthor(optional):
boolean
The user's app author status.
-
isCommunitiesEnabled(optional):
boolean
True if communities are enabled.
-
isCommunityAdmin(optional):
boolean
The user's community admin status.
-
isContentSearchEnabled(optional):
boolean
True if content search is enabled.
-
isMaximumFileSizeEnabled(optional):
boolean
Maximum per part (file) size enabled status. If the value is false, there is no limit.
-
isMaximumRequestSizeEnabled(optional):
boolean
Maximum total request size enabled status. If the value is false, there is no limit.
-
isOutsider(optional):
boolean
The user's outsider status.
-
isSiteAdmin(optional):
boolean
The user's site admin status.
-
isTenantAdmin(optional):
boolean
The user's service (previously called tenant) admin status.
-
isTerseMode(optional):
boolean
True if terse responses are enabled for API requests. (If enabled, fields will not be included in the response if they hold a boolean 'false' or an integer or long 'zero' value.)
-
iteration(optional):
string
The development iteration.
-
languageLocale(optional):
string
The locale of the recommended language translation bundle. The translation bundle locale is inferred by the server based on the user's profile, the HTTP accept-language header, the server application configuration, the host machine setting, and the available translation bundles. The intent is for clients to use this locale for selecting the translation bundle to present to the user. The locale will be an exact match of one of our officially supported translations, so clients do not need to implement their own fallback algorithm.
-
logoImage(optional):
string
Logo image. Can be null.
-
logoText(optional):
string
Logo text. Can be null.
-
logoutURL(optional):
string
The URL to redirect to after user logout to complete the logout process, typically used in SSO integrations. Can be null if this step is not necessary.
-
mailHost(optional):
string
The mail host that a client can use.
-
maximumChatSize(optional):
integer(int64)
Maximum total chat size in bytes.
-
maximumFileSize(optional):
integer(int64)
Maximum per part (file) size in bytes.
-
maximumRequestsInBatch(optional):
integer(int64)
Maximum requests in a batch.
-
maximumRequestSize(optional):
integer(int64)
Maximum total request size in bytes.
-
numEnteredClients(optional):
integer(int32)
If enterHive is enabled during login, the number of clients entered for the session.
-
platformURL(optional):
string
Developer site (previously called Platform) URL.
-
presenceIdleMS(optional):
integer(int64)
The expected client presence idle timeout in milliseconds.
-
pushEnabled(optional):
array pushEnabled
Determine which push devices are currently enabled.
-
revisionCommitID(optional):
string
The revision commit ID (hash) or 'no-commitid'.
-
revisionDate(optional):
string
The revision date in ISO 8601 format or 'no-date'.
-
revisionTag(optional):
string
The revision tag or 'no-tag'.
-
serverDate(optional):
string(date)
Server date. Useful to sync dates sent by the server to local time.
-
serverDateInISO8601Format(optional):
string
Server date. Useful to sync dates sent by the server to local time, in ISO 8601 format.
-
serverHosts(optional):
array serverHosts
List of all server access hosts.
-
serverMethod(optional):
string
Server access method.
-
serverPort(optional):
integer(int32)
Server access port.
-
socialChannelHost(optional):
string
Collaboration channel access host.
-
socialChannelPath(optional):
string
Collaboration channel access path.
-
socialChannelServletName(optional):
string
Collaboration channel access servlet name.
-
socialChannelURL(optional):
string
Collaboration channel access URL.
-
supportDescription(optional):
string
The support description.
-
themeColor(optional):
string
The theme color.
-
user(optional):
object XV1PeopleInfo
V1 People Information DTO.
-
version(optional):
string
The complete release version string.
Nested Schema : pushEnabled
Type:
array
Determine which push devices are currently enabled.
Show Source
Nested Schema : serverHosts
Type:
array
List of all server access hosts.
Show Source
-
Array of:
string
List of all server access hosts.
Nested Schema : XV1PeopleInfo
Type:
object
V1 People Information DTO.
Show Source
-
addressBuilding(optional):
string
This user's building.
-
addressCity(optional):
string
This user's city.
-
addressCountry(optional):
string
This user's country.
-
addressLine1(optional):
string
This user's street address line 1.
-
addressLine2(optional):
string
This user's street address line 2.
-
addressOffice(optional):
string
This user's office.
-
addressState(optional):
string
This user's state.
-
addressZipCode(optional):
string
This user's ZIP Code.
-
altitude(optional):
number(double)
The object's altitude.
-
biography(optional):
string
The biography for this user.
-
chatURL(optional):
string(url)
A URL specifying this user's one-on-one conversation with the current user.
-
collectionURL(optional):
string(url)
A URL to this object's containing collection.
-
company(optional):
string
This user's company.
-
conversationURL(optional):
string(url)
A URL to this object's containing conversation.
-
costCenter(optional):
string
This user's cost center.
-
createdByID(optional):
An object's unique identifier from a long integer representation.
-
createdByURL(optional):
string(url)
A URL to the user that created this object.
-
createdByUserDisplayName(optional):
string
The display name of the user that created this object.
-
createdByUserName(optional):
string
The name of the user that created this object.
-
createdDate(optional):
string(date)
The date this object was created.
-
createdDateInISO8601Format(optional):
string
The date this object was created, in ISO 8601 format.
-
dateFormatLocale(optional):
string(uuid)
This user's locale for formatting dates.
-
description(optional):
string
The user profile description.
-
displayName(optional):
string
The display name of this object.
-
eMailAddress(optional):
string
The email address for this user.
-
expertise(optional):
string
This user's expertise.
-
followersURL(optional):
string(url)
This user's followers URL. Users that are followers of this user.
-
followingURL(optional):
string(url)
This user's following URL. Users that this user is following.
-
fullName(optional):
string
The full name for this user.
-
id(optional):
An object's unique identifier from a long integer representation.
-
interests(optional):
string
This user's interests.
-
isDeleted(optional):
boolean
True if this user is deleted.
-
isEnabled(optional):
boolean
True if this user is enabled.
-
isHidden(optional):
boolean
True if the user is to be hidden.
-
isIntegrationUser(optional):
boolean
True if the user is an integration user.
-
isInternal(optional):
boolean
True if the user is internal, false if the user is external.
-
isOutsider(optional):
boolean
True if the user is an outsider.
-
isRemoved(optional):
boolean
True if this message has been removed.
-
languageLocale(optional):
string(uuid)
This user's language locale.
-
lastConnectedDate(optional):
string(date)
The date this user last connected.
-
lastConnectedDateInISO8601Format(optional):
string
The date this user last connected, in ISO 8601 format.
-
lastDisconnectedDate(optional):
string(date)
The date this user last disconnected.
-
lastDisconnectedDateInISO8601Format(optional):
string
The date this user last disconnected, in ISO 8601 format.
-
latitude(optional):
number(double)
The object's latitude.
-
libraryURL(optional):
string(url)
A URL specifying this user's library.
-
link(optional):
string
A URL, if any, that this user shows on their wall or profile as their link.
-
location(optional):
string
This user's location.
-
longitude(optional):
number(double)
The object's longitude.
-
modifiedByID(optional):
An object's unique identifier from a long integer representation.
-
modifiedByURL(optional):
string(url)
A URL to the user that last modified this object.
-
modifiedByUserDisplayName(optional):
string
The display name of the user that last modified this object.
-
modifiedByUserName(optional):
string
The name of the user that last modified this object.
-
modifiedDate(optional):
string(date)
The date this object was last modified.
-
modifiedDateInISO8601Format(optional):
string
The date this object was last modified, in ISO 8601 format.
-
name(optional):
string
The name of this object.
-
objectType(optional):
string
The type of this object.
-
organization(optional):
string
This user's organization.
-
originalPictureURL(optional):
string(url)
The original picture URL.
-
profilePictureURL(optional):
string(url)
The profile picture URL (150 px by 150 px).
-
propertiesURL(optional):
string(url)
This user's properties URL.
-
removedByID(optional):
An object's unique identifier from a long integer representation.
-
removedByURL(optional):
string(url)
A URL to the user that last removed this object.
-
removedByUserDisplayName(optional):
string
The display name of the user that last removed this object.
-
removedByUserName(optional):
string
The name of the user that last removed this object.
-
removedDate(optional):
string(date)
The date this object was removed.
-
removedDateInISO8601Format(optional):
string
The date this object was removed, in ISO 8601 format.
-
scaledPictureURL(optional):
string(url)
The scaled picture URL (44 px by 44 px).
-
socialObjectURL(optional):
string(url)
A URL to this object's containing collaboration object.
-
socialObjectViewID(optional):
string
The user's current collaboration object view ID (can be null).
-
statisticsURL(optional):
string(url)
A URL to retrieve this user's statistics.
-
timeZone(optional):
string(uuid)
This user's time zone.
-
title(optional):
string
This user's title.
-
url(optional):
string(url)
A URL to this object.
-
wallURL(optional):
string(url)
A URL specifying this user's wall.
Nested Schema : XDeviceType
Type:
Show Source
object
-
field(optional):
string
Allowed Values:
[ "APNS", "EMAIL", "GCM", "SMS", "TXT" ]
The device types.