Accept the terms and conditions for the authenticated user.

Path Parameters:

Return Status:

Since: 3.4

Add expertise tag(s) to a person

Path Parameters:

Takes:

Return Status:

Used to approve a tag that a user has been endorsed with. The current user and the specified user must be the same or an authorization error will occur.

Path Parameters:

Return Status:

Save a new set of extended properties for a person with specified characteristics, and return an entity representing the newly created extended properties.

This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, the properties being created on the target person will be those associated with the consumer of the oAuth token.

Path Parameters:

Takes:

Retrieves:

Return Status:

Save a new set of extended properties for a person with specified characteristics, and return an entity representing the newly created extended properties.

This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, this service will validate that the consumer of the oAuth token can access the specified add-on.

Path Parameters:

Takes:

Retrieves:

Return Status:

Since: 3.9

Create a following relationship between the specified user and the specified followed user.

Path Parameters:

Return Status:

Create a new Page for a user based on the contents of the specified Page. Only modifiable fields that actually provide a value in the incoming entity are processed.

Path Parameters:

Return Status:

Since: 3.9

Create a Person for a new user based on the contents of the specified Person. Only modifiable fields that actually provide a value in the incoming entity are processed.

The JSON representation of the absolute minimum information that must be included to create a new person looks like this:

  {
      "emails" : [ {
          "value" : "{emailAddress}",
          "type" : "work",
          "primary" : true,
          "jive_label" : "Email"
      } ],
      "jive" : {
          "password" : "{password}",
          "username" : "{username}"
      },
      "name" : {
      "familyName" : "{lastName}",
      "givenName" : "{firstName}"
      }
  }
 

Query Parameters:

Takes:

Return Status:

Create a manager-report relationship between the specified user and the specified report user.

Path Parameters:

Return Status:

Create a new custom stream for the specified user, based on the information in the specified Stream. Then, return a 201 with a Stream reflecting the new stream configuration. You can discover the maximum allowed length for stream names by using the metadata property "feature.stream.name.length".

The following fields are processed from the incoming stream entity:

• name - the name of the new stream (must be unique per user)
• receiveEmails - flag indicating whether the user wants to receive email from this stream

Path Parameters:

Query Parameters:

Takes:

Retrieves:

Return Status:

Create a personal Task.

The JSON representation of the absolute minimum information that must be included to create a new personal task looks like this:

 {
  "subject": "Clean the carpet",
  "dueDate" : "2013-07-12T06:59:59.999+0000",
  "type": "task"
 }
 

Path Parameters:

Query Parameters:

Takes:

Return Status:

Since: 3.1

Delete the active avatar for the specified user. Only uploaded avatars can be deleted. The system avatar will be selected for the user after the delete operation is completed.

Path Parameters:

Return Status:

Remove an expertise tag from a person.

Path Parameters:

Return Status:

Remove an expertise tag from a person, where the name of the tag is specified query string. This alternative version allows backslashes in the tag name

Path Parameters:

Query Parameters:

Return Status:

Delete the existing extended properties for the specified person.

This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, the properties deleted from the target person will be those associated with the consumer of the oAuth token.

Path Parameters:

Return Status:

Delete the existing extended properties for the specified person.

This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, this service will validate that the consumer of the oAuth token can access the specified add-on.

Path Parameters:

Return Status:

Since: 3.9

Delete a following relationship between the specified user and the specified followed user.

Path Parameters:

Return Status:

Trigger a background task to delete the specified person, and all of their content. Returns an HTTP 202 (Accepted) status to indicate the the deletion request has been accepted. The only way that a client can tell it has been completed is by trying a GET on the person URI, and waiting until a NotFoundException is returned.

WARNING - It is possible that errors during the deletion process might cause the delete to be abandoned.

Path Parameters:

Takes:

Return Status:

Delete the specified profile image for the specified user.

Path Parameters:

Return Status:

Delete (i.e. retire) an existing manager-report relationship between the specified manager user and the specified report user.

Path Parameters:

Return Status:

Return the specified profile activities for the specified user.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Return a paginated list of Persons for users that match the specified criteria. Users will be sorted by userID ascending.

This service supports the following filters. Only one filter of each type is allowed. Parameters, when used, should be wrapped in parentheses, and multiple values separated by commas. See the examples for clarification.

Query Parameters:

Return Status:

Return the binary content of the avatar image for the specified user. If width is defined and height is not defined (or vice versa) then the returned size will depend on the value defined for aspect ratio. For instance, if the original image is 100 (W)x 600 (H) and 50 (W) is requested with preserveAspectRatio equals true, then the returned image will be 50 (W) x 300 (H). If preserveAspectRatio was false then the returned image will be 50 (W) x 600 (H). Remember that width and height are maximum possible values. This means that if you request 150 (W) then you will get 100 (W) since that is the size of the image.

Parameters width or height are optional, when not defined then the original avatar image will be returned.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Return the binary content of the avatar image for deactivated users.

Query Parameters:

Retrieves:

Return Status:

Return the personal blog for the specified user.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Return a paginated list of Persons about colleagues of the specified person (i.e. those who report to the same manager that this person does).

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Return a paginated list of Persons about bidirectionally related users that you and the specified person have in common (i.e. any person whom you and the specified person are both following, and who is following both you and specified person).

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Return the specified extended properties of a place.

This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, the properties being fetched from the target person will be those associated with the consumer of the oAuth token.

Path Parameters:

Retrieves:

Return Status:

Return the specified extended properties of a place.

This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, this service will validate that the consumer of the oAuth token can access the specified add-on.

Path Parameters:

Retrieves:

Return Status:

Since: 3.9

Return a list of featured content objects for the specified person. This is the same as requesting the featured content for the specified person's container via getFeaturedContent(personID, filters, fields, abridged).

This service supports the following filters. Parameters, when used, should be wrapped in parentheses, and multiple values separated by commas. See the examples for clarification.

The returned list may contain a mixture of content entities of various types. On any given content object entity, use the type field to determine the type of that particular content.

Query Parameters:

Retrieves:

Return Status:

Since: 3.2

Return the set of fields that can be used for filtering users in this Jive instance.

Retrieves:

Return a paginated list of Persons about people who are following the specified person.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Return a paginated list of Persons about people the specified person is following.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Return a list of Streams in which the requesting user is following this person (if any).

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Return a Person describing the followed person, if a following relationship from the specified person exists.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Return a Person describing the manager of the specified person.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Return metadata about our data object type in this Jive instance.

Retrieves:

Return Status:

Return the specified news activity visible to the requesting person.

Query Parameters:

Retrieves:

Return Status:

Return a list of pages(currently only one) Page that a user has created with parent as user. currently you can only create one page with user as parent

Path Parameters:

Return Status:

Since: 3.9

Return a new page, that is not persistent, based on the default Your View page.

Path Parameters:

Query Parameters:

Return Status:

Returns all of the tags that the user has been endorsed with but has not yet approved. The current user and the specified user must be the same or a forbidden error will occur.

Path Parameters:

Retrieves:

Return Status:

Return a paginated list of Persons for users that match the specified criteria.

This service supports the following filters. Only one filter of each type is allowed. Parameters, when used, should be wrapped in parentheses, and multiple values separated by commas. See the examples for clarification.

This service supports the following sort types.

Query Parameters:

Return Status:

Return a Person describing the requested Jive user by ID.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Return a Person describing the requested Jive user by email address.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Return a Person describing the requested Jive user by external identity.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Since: 3.6

Return a Person describing the requested Jive user by username.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Return the specified private properties of a place.

Path Parameters:

Retrieves:

Return Status:

Return the specified ProfileFieldPrivacy that describes the visibility of the profile field.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Since: 3.13

Return a paginated list of ProfileFieldPrivacys that describes the visibility of each profile field.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Since: 3.13

Return a ProfileImage describing the specified profile image information for the specified user.

Path Parameters:

Retrieves:

Return Status:

Return the binary profile image data for the specified profile image for the specified user.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Return a list of ProfileImages for the profile images of the specified person.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Return the specified activities from the stream of all activity visible to the requesting person.

Query Parameters:

Retrieves:

Return Status:

Return a list of recommended Persons for users. Do a GET to /api/core/v3/metadata/properties/feature.recommender.enabled to figure out whether recommendation service is enabled or not.

Query Parameters:

Return Status:

Since: 3.1

Return a Person describing the specified direct report of the specified person, if such a relationship exists.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Return a paginated list of Persons describing the direct reports of the specified person.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Return metadata about the resources available for our data object type in this Jive instance.

Retrieves:

Returns the system entitlements and whether the specified user is entitled.

Path Parameters:

Retrieves:

Return Status:

Return a list of SecurityGroups that the specified user is a member of. Note that this list will NOT include any security groups that this person is an administrator of. Because the number of security groups will generally be very small, pagination is not supported.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Return a paginated list of Persons about the people with whom the specified person interacts most frequently.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Return a list of Streams for the specified user. Because the number of streams will generally be very small, pagination is not supported.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Return the set of fields for our object type that are supported in this Jive instance.

Retrieves:

Returns all the tags that the current user endorsed the user with the id specified with.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Return a paginated list of personal tasks for the specified person.

This service supports the following filters. Parameters, when used, should be wrapped in parentheses, and multiple values separated by commas. See the examples for clarification.

This service supports the following sort types.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Since: 3.1

Return the details of terms and conditions or nothing if terms and conditions is not enabled. Note terms and conditions can be specified inline as text or via an extra url that the customer specifies.

Path Parameters:

Return Status:

Since: 3.4

Return the top expertise for the specified user.

Path Parameters:

Query Parameters:

Return Status:

Return a list of a user's trending content objects. It's possible for some Jive instances to have recommendation disabled, or too few recommendations, in which case the service falls back to the user's most-liked content unless otherwise specified with the fallback parameter.

The returned list may contain a mixture of content entities of various types. On any given content object entity, use the type field to determine the type of that particular content.

This service supports the following filters. Parameters, when used, should be wrapped in parentheses, and multiple values separated by commas. See the examples for clarification.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Return a list of trending Persons for users that match the specified filter criteria. Do a GET to /api/core/v3/metadata/properties/feature.recommender.enabled to figure out whether recommendation service is enabled or not.

This service supports the following filters. Parameters, when used, should be wrapper in parenthesis. See the examples for clarification.

Query Parameters:

Return Status:

Since: 3.1

Return a list of trending places. It's possible for some Jive instances to have recommendation disabled, or too few recommendations, in which case the service falls back to the user's most frequent places unless otherwise specified with the fallback parameter.

The returned list may contain a mixture of place entities of various types (Blog, Group, Project, and Space). On any given place entity, use the type field to determine the type of that particular place.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Since: 3.1

Return paginated list of people that are experts on the specified tag.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Return the persons that endorsed the specified person with the specified tag.

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Save a new set of private properties for a person with specified characteristics, and return an entity representing the newly created private properties.

Path Parameters:

Takes:

Retrieves:

Return Status:

Set the binary content of the active avatar image for the specified user. The image bits will be uploaded using a multipart request.

Path Parameters:

Query Parameters:

Takes:

Return Status:

Set the binary content of the active avatar image for the specified user by specifying the URL where the image will be fetched from.

Path Parameters:

Query Parameters:

Return Status:

Since: 3.14

Replace the list of Streams in which the requesting user is following this person.

Path Parameters:

Query Parameters:

Takes:

Retrieves:

Return Status:

Since: 3.3

Create the specified profile image for the specified user at the next available index. Return a 201 (Created) status with a Location header containing the URI of the new profile image.

Path Parameters:

Query Parameters:

Form Parameters:

Takes:

Retrieves:

Return Status:

Create or replace the specified profile image for the specified user. Return a 201 (Created) status with a Location header containing the URI of the new profile image.

Path Parameters:

Query Parameters:

Form Parameters:

Takes:

Retrieves:

Return Status:

Removes a tag endorsement from the current user to the specified user.

Path Parameters:

Return Status:

Update the specified user based on the contents of the specified Person. Only modifiable fields that actually provide a value in the incoming entity are processed. Then, return a Person reflecting the processed changes.

Path Parameters:

Takes:

Retrieves:

Return Status:

Update the specified ProfileFieldPrivacy that describes the visibility of the profile field.

Path Parameters:

Query Parameters:

Takes:

Retrieves:

Return Status:

Since: 3.14