Jump to

• Request
• Response

Update an existing connection.

put

/social/api/v1/connections

Request

Supported Media Types

• application/json

Body ()

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.

{
    "description":"V1 Connection Update Information.",
    "properties":{
        "isImpersonate":{
            "description":"Set or unset impersonate using the specified name.",
            "type":"boolean"
        },
        "isImpersonateEx":{
            "description":"Set or unset impersonate using the specified name. Also uses the  fields realmID and sendInvitation.",
            "type":"boolean"
        },
        "isOnBehalfOf":{
            "description":"Set or unset on-behalf-of using the specified name.",
            "type":"boolean"
        },
        "isOnBehalfOfEx":{
            "description":"Set or unset on-behalf-of using the specified name. Also uses the  fields realmID and sendInvitation.",
            "type":"boolean"
        },
        "isTerseMode":{
            "description":"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.",
            "type":"boolean"
        },
        "name":{
            "description":"The user name.",
            "type":"string"
        },
        "realmID":{
            "$ref":"#/definitions/XObjectID"
        },
        "sendInvitation":{
            "description":"The user name's send invitation option. Used for isOnBehalfOfEx or isImpersonateEx only.",
            "type":"boolean"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

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.

{
    "description":"V1 Conversation Property Information DTO.",
    "properties":{
        "analyticsURL":{
            "description":"Analytics URL.",
            "type":"string"
        },
        "apiRandomID":{
            "description":"A random ID that should be sent along with all API requests in a header 'X-Waggle-RandomID'.",
            "type":"string"
        },
        "apiVersion":{
            "description":"The current API version of the API accepted by the server.",
            "type":"integer",
            "format":"int32"
        },
        "apiVersionMinimum":{
            "description":"The minimum API version of the API accepted by the server.",
            "type":"integer",
            "format":"int32"
        },
        "backChannelHost":{
            "description":"Back-channel access host.",
            "type":"string"
        },
        "backChannelPath":{
            "description":"Back-channel access path.",
            "type":"string"
        },
        "backChannelServletName":{
            "description":"Back-channel access servlet name.",
            "type":"string"
        },
        "backChannelURL":{
            "description":"Back-channel access URL.",
            "type":"string"
        },
        "clientAdminURL":{
            "description":"Client admin URL.",
            "type":"string"
        },
        "clientDownloadURL":{
            "description":"Outlook or Desktop Client download URL.",
            "type":"string"
        },
        "clientDownloadURL_Android":{
            "description":"Android Client download URL.",
            "type":"string"
        },
        "clientDownloadURL_Desktop":{
            "description":"Desktop Client download URL.",
            "type":"string"
        },
        "clientDownloadURL_iOS":{
            "description":"iOS Client download URL.",
            "type":"string"
        },
        "clientDownloadURL_Outlook":{
            "description":"Outlook Client download URL.",
            "type":"string"
        },
        "clientHelpURL":{
            "description":"Client help URL.",
            "type":"string"
        },
        "clientUpdateURL":{
            "description":"Outlook or Desktop Client update URL.",
            "type":"string"
        },
        "clientUpdateURL_Desktop":{
            "description":"Desktop Client update URL.",
            "type":"string"
        },
        "clientUpdateURL_Outlook":{
            "description":"Outlook Client update URL.",
            "type":"string"
        },
        "communityURL":{
            "description":"The community URL.",
            "type":"string"
        },
        "contextName":{
            "description":"Front-channel or back-channel access context name.",
            "type":"string"
        },
        "contextURL":{
            "description":"Front-channel or back-channel access context base URL.",
            "type":"string"
        },
        "dateFormatLocale":{
            "description":"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'.",
            "type":"string"
        },
        "externalMobileClientURL":{
            "description":"External Mobile Client URL.",
            "type":"string"
        },
        "externalWebClientURL":{
            "description":"External Web Client URL.",
            "type":"string"
        },
        "federatedSSOApplicationName":{
            "description":"Mobile Client Federated SSO Application Name.",
            "type":"string"
        },
        "federatedSSOEnabled":{
            "description":"Mobile Client Federated SSO enabled status.",
            "type":"boolean"
        },
        "federatedSSOLoginFailureURL":{
            "description":"Mobile Client Federated SSO Login Failure URL.",
            "type":"string"
        },
        "federatedSSOLoginSuccessURL":{
            "description":"Mobile Client Federated SSO Login Success URL.",
            "type":"string"
        },
        "federatedSSOLoginURL":{
            "description":"Mobile Client Federated SSO Login URL.",
            "type":"string"
        },
        "federatedSSOLogoutURL":{
            "description":"Mobile Client Federated SSO Logout URL.",
            "type":"string"
        },
        "federatedSSORequiredTokens":{
            "description":"Mobile Client Tokens.",
            "type":"string"
        },
        "flagAllLimitHard":{
            "description":"Flag all users hard limit.",
            "type":"integer",
            "format":"int32"
        },
        "flagAllLimitSoft":{
            "description":"Flag all users soft limit.",
            "type":"integer",
            "format":"int32"
        },
        "frontChannelHost":{
            "description":"Front-channel access host.",
            "type":"string"
        },
        "frontChannelPath":{
            "description":"Front-channel access path.",
            "type":"string"
        },
        "frontChannelServletName":{
            "description":"Front-channel access servlet name.",
            "type":"string"
        },
        "frontChannelURL":{
            "description":"Front-channel access URL.",
            "type":"string"
        },
        "hiveGUID":{
            "description":"The hive GUID, which is unique across all instances.",
            "type":"string"
        },
        "hiveHash":{
            "description":"The hive hash, which is unique across all instances. This is the first 4 characters of the hiveGUID.",
            "type":"string"
        },
        "isAppAuthor":{
            "description":"The user's app author status.",
            "type":"boolean"
        },
        "isCommunitiesEnabled":{
            "description":"True if communities are enabled.",
            "type":"boolean"
        },
        "isCommunityAdmin":{
            "description":"The user's community admin status.",
            "type":"boolean"
        },
        "isContentSearchEnabled":{
            "description":"True if content search is enabled.",
            "type":"boolean"
        },
        "isMaximumFileSizeEnabled":{
            "description":"Maximum per part (file) size enabled status. If the value is false, there is no limit.",
            "type":"boolean"
        },
        "isMaximumRequestSizeEnabled":{
            "description":"Maximum total request size enabled status. If the value is false, there is no limit.",
            "type":"boolean"
        },
        "isOutsider":{
            "description":"The user's outsider status.",
            "type":"boolean"
        },
        "isSiteAdmin":{
            "description":"The user's site admin status.",
            "type":"boolean"
        },
        "isTenantAdmin":{
            "description":"The user's service (previously called tenant) admin status.",
            "type":"boolean"
        },
        "isTerseMode":{
            "description":"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.)",
            "type":"boolean"
        },
        "iteration":{
            "description":"The development iteration.",
            "type":"string"
        },
        "languageLocale":{
            "description":"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.",
            "type":"string"
        },
        "logoImage":{
            "description":"Logo image. Can be null.",
            "type":"string"
        },
        "logoText":{
            "description":"Logo text. Can be null.",
            "type":"string"
        },
        "logoutURL":{
            "description":"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.",
            "type":"string"
        },
        "mailHost":{
            "description":"The mail host that a client can use.",
            "type":"string"
        },
        "maximumChatSize":{
            "description":"Maximum total chat size in bytes.",
            "type":"integer",
            "format":"int64"
        },
        "maximumFileSize":{
            "description":"Maximum per part (file) size in bytes.",
            "type":"integer",
            "format":"int64"
        },
        "maximumRequestsInBatch":{
            "description":"Maximum requests in a batch.",
            "type":"integer",
            "format":"int64"
        },
        "maximumRequestSize":{
            "description":"Maximum total request size in bytes.",
            "type":"integer",
            "format":"int64"
        },
        "numEnteredClients":{
            "description":"If enterHive is enabled during login, the number of clients entered for the session.",
            "type":"integer",
            "format":"int32"
        },
        "platformURL":{
            "description":"Developer site (previously called Platform) URL.",
            "type":"string"
        },
        "presenceIdleMS":{
            "description":"The expected client presence idle timeout in milliseconds.",
            "type":"integer",
            "format":"int64"
        },
        "pushEnabled":{
            "description":"Determine which push devices are currently enabled.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XDeviceType"
            }
        },
        "revisionCommitID":{
            "description":"The revision commit ID (hash) or 'no-commitid'.",
            "type":"string"
        },
        "revisionDate":{
            "description":"The revision date in ISO 8601 format or 'no-date'.",
            "type":"string"
        },
        "revisionTag":{
            "description":"The revision tag or 'no-tag'.",
            "type":"string"
        },
        "serverDate":{
            "description":"Server date. Useful to sync dates sent by the server to local time.",
            "type":"string",
            "format":"date"
        },
        "serverDateInISO8601Format":{
            "description":"Server date. Useful to sync dates sent by the server to local time, in ISO 8601 format.",
            "type":"string"
        },
        "serverHosts":{
            "description":"List of all server access hosts.",
            "type":"array",
            "items":{
                "description":"List of all server access hosts.",
                "type":"string"
            }
        },
        "serverMethod":{
            "description":"Server access method.",
            "type":"string"
        },
        "serverPort":{
            "description":"Server access port.",
            "type":"integer",
            "format":"int32"
        },
        "socialChannelHost":{
            "description":"Collaboration channel access host.",
            "type":"string"
        },
        "socialChannelPath":{
            "description":"Collaboration channel access path.",
            "type":"string"
        },
        "socialChannelServletName":{
            "description":"Collaboration channel access servlet name.",
            "type":"string"
        },
        "socialChannelURL":{
            "description":"Collaboration channel access URL.",
            "type":"string"
        },
        "supportDescription":{
            "description":"The support description.",
            "type":"string"
        },
        "themeColor":{
            "description":"The theme color.",
            "type":"string"
        },
        "user":{
            "$ref":"#/definitions/XV1PeopleInfo"
        },
        "version":{
            "description":"The complete release version string.",
            "type":"string"
        }
    }
}

Nested Schema : pushEnabled

Type: array

Determine which push devices are currently enabled.

Show Source

• Array of: object XDeviceType

{
    "description":"Determine which push devices are currently enabled.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/XDeviceType"
    }
}

Nested Schema : serverHosts

Type: array

List of all server access hosts.

Show Source

• Array of: string
  List of all server access hosts.

{
    "description":"List of all server access hosts.",
    "type":"array",
    "items":{
        "description":"List of all server access hosts.",
        "type":"string"
    }
}

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.

{
    "description":"V1 People Information DTO.",
    "properties":{
        "addressBuilding":{
            "description":"This user's building.",
            "type":"string"
        },
        "addressCity":{
            "description":"This user's city.",
            "type":"string"
        },
        "addressCountry":{
            "description":"This user's country.",
            "type":"string"
        },
        "addressLine1":{
            "description":"This user's street address line 1.",
            "type":"string"
        },
        "addressLine2":{
            "description":"This user's street address line 2.",
            "type":"string"
        },
        "addressOffice":{
            "description":"This user's office.",
            "type":"string"
        },
        "addressState":{
            "description":"This user's state.",
            "type":"string"
        },
        "addressZipCode":{
            "description":"This user's ZIP Code.",
            "type":"string"
        },
        "biography":{
            "description":"The biography for this user.",
            "type":"string"
        },
        "chatURL":{
            "description":"A URL specifying this user's one-on-one conversation with the current user.",
            "type":"string",
            "format":"url"
        },
        "company":{
            "description":"This user's company.",
            "type":"string"
        },
        "costCenter":{
            "description":"This user's cost center.",
            "type":"string"
        },
        "dateFormatLocale":{
            "description":"This user's locale for formatting dates.",
            "type":"string",
            "format":"uuid"
        },
        "description":{
            "description":"The user profile description.",
            "type":"string"
        },
        "eMailAddress":{
            "description":"The email address for this user.",
            "type":"string"
        },
        "expertise":{
            "description":"This user's expertise.",
            "type":"string"
        },
        "followersURL":{
            "description":"This user's followers URL. Users that are followers of this user.",
            "type":"string",
            "format":"url"
        },
        "followingURL":{
            "description":"This user's following URL. Users that this user is following.",
            "type":"string",
            "format":"url"
        },
        "fullName":{
            "description":"The full name for this user.",
            "type":"string"
        },
        "interests":{
            "description":"This user's interests.",
            "type":"string"
        },
        "isDeleted":{
            "description":"True if this user is deleted.",
            "type":"boolean"
        },
        "isEnabled":{
            "description":"True if this user is enabled.",
            "type":"boolean"
        },
        "isHidden":{
            "description":"True if the user is to be hidden.",
            "type":"boolean"
        },
        "isIntegrationUser":{
            "description":"True if the user is an integration user.",
            "type":"boolean"
        },
        "isInternal":{
            "description":"True if the user is internal, false if the user is external.",
            "type":"boolean"
        },
        "isOutsider":{
            "description":"True if the user is an outsider.",
            "type":"boolean"
        },
        "languageLocale":{
            "description":"This user's language locale.",
            "type":"string",
            "format":"uuid"
        },
        "lastConnectedDate":{
            "description":"The date this user last connected.",
            "type":"string",
            "format":"date"
        },
        "lastConnectedDateInISO8601Format":{
            "description":"The date this user last connected, in ISO 8601 format.",
            "type":"string"
        },
        "lastDisconnectedDate":{
            "description":"The date this user last disconnected.",
            "type":"string",
            "format":"date"
        },
        "lastDisconnectedDateInISO8601Format":{
            "description":"The date this user last disconnected, in ISO 8601 format.",
            "type":"string"
        },
        "libraryURL":{
            "description":"A URL specifying this user's library.",
            "type":"string",
            "format":"url"
        },
        "link":{
            "description":"A URL, if any, that this user shows on their wall or profile as their link.",
            "type":"string"
        },
        "location":{
            "description":"This user's location.",
            "type":"string"
        },
        "organization":{
            "description":"This user's organization.",
            "type":"string"
        },
        "propertiesURL":{
            "description":"This user's properties URL.",
            "type":"string",
            "format":"url"
        },
        "socialObjectViewID":{
            "description":"The user's current collaboration object view ID (can be null).",
            "type":"string"
        },
        "statisticsURL":{
            "description":"A URL to retrieve this user's statistics.",
            "type":"string",
            "format":"url"
        },
        "timeZone":{
            "description":"This user's time zone.",
            "type":"string",
            "format":"uuid"
        },
        "title":{
            "description":"This user's title.",
            "type":"string"
        },
        "wallURL":{
            "description":"A URL specifying this user's wall.",
            "type":"string",
            "format":"url"
        },
        "originalPictureURL":{
            "description":"The original picture URL.",
            "type":"string",
            "format":"url"
        },
        "profilePictureURL":{
            "description":"The profile picture URL (150 px by 150 px).",
            "type":"string",
            "format":"url"
        },
        "scaledPictureURL":{
            "description":"The scaled picture URL (44 px by 44 px).",
            "type":"string",
            "format":"url"
        },
        "altitude":{
            "description":"The object's altitude.",
            "type":"number",
            "format":"double"
        },
        "collectionURL":{
            "description":"A URL to this object's containing collection.",
            "type":"string",
            "format":"url"
        },
        "conversationURL":{
            "description":"A URL to this object's containing conversation.",
            "type":"string",
            "format":"url"
        },
        "createdByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "createdByURL":{
            "description":"A URL to the user that created this object.",
            "type":"string",
            "format":"url"
        },
        "createdByUserDisplayName":{
            "description":"The display name of the user that created this object.",
            "type":"string"
        },
        "createdByUserName":{
            "description":"The name of the user that created this object.",
            "type":"string"
        },
        "createdDate":{
            "description":"The date this object was created.",
            "type":"string",
            "format":"date"
        },
        "createdDateInISO8601Format":{
            "description":"The date this object was created, in ISO 8601 format.",
            "type":"string"
        },
        "displayName":{
            "description":"The display name of this object.",
            "type":"string"
        },
        "id":{
            "$ref":"#/definitions/XObjectID"
        },
        "isRemoved":{
            "description":"True if this message has been removed.",
            "type":"boolean"
        },
        "latitude":{
            "description":"The object's latitude.",
            "type":"number",
            "format":"double"
        },
        "longitude":{
            "description":"The object's longitude.",
            "type":"number",
            "format":"double"
        },
        "modifiedByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "modifiedByURL":{
            "description":"A URL to the user that last modified this object.",
            "type":"string",
            "format":"url"
        },
        "modifiedByUserDisplayName":{
            "description":"The display name of the user that last modified this object.",
            "type":"string"
        },
        "modifiedByUserName":{
            "description":"The name of the user that last modified this object.",
            "type":"string"
        },
        "modifiedDate":{
            "description":"The date this object was last modified.",
            "type":"string",
            "format":"date"
        },
        "modifiedDateInISO8601Format":{
            "description":"The date this object was last modified, in ISO 8601 format.",
            "type":"string"
        },
        "name":{
            "description":"The name of this object.",
            "type":"string"
        },
        "objectType":{
            "description":"The type of this object.",
            "type":"string"
        },
        "removedByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "removedByURL":{
            "description":"A URL to the user that last removed this object.",
            "type":"string",
            "format":"url"
        },
        "removedByUserDisplayName":{
            "description":"The display name of the user that last removed this object.",
            "type":"string"
        },
        "removedByUserName":{
            "description":"The name of the user that last removed this object.",
            "type":"string"
        },
        "removedDate":{
            "description":"The date this object was removed.",
            "type":"string",
            "format":"date"
        },
        "removedDateInISO8601Format":{
            "description":"The date this object was removed, in ISO 8601 format.",
            "type":"string"
        },
        "socialObjectURL":{
            "description":"A URL to this object's containing collaboration object.",
            "type":"string",
            "format":"url"
        },
        "url":{
            "description":"A URL to this object.",
            "type":"string",
            "format":"url"
        }
    }
}

Nested Schema : XDeviceType

Type: object

Show Source

• field(optional): string
  Allowed Values: [ "APNS", "EMAIL", "GCM", "SMS", "TXT" ]

  The device types.

{
    "properties":{
        "field":{
            "type":"string",
            "description":"The device types.",
            "enum":[
                "APNS",
                "EMAIL",
                "GCM",
                "SMS",
                "TXT"
            ]
        }
    }
}

Back to Top