Add the specified people as administrators of the specified security group. If any error occurs while adding a particular user, all adds will be rolled back.

Availability:

Available to Jive admins only

Path Parameters:

Name	Type	Required	Description
securityGroupID	String	true	ID of the security group to which administrators should be added

Takes:

URIs of the people to be added as administrators. Limit the number of URIs per call to 200.

Return Status:

HTTP Status Code	Description
201 (Created)	Request was successful
400 (Bad Request)	if any of the input fields are malformed
409 (Conflict)	if a person is added as both an administrator and a regular member
403 (Forbidden)	if the requesting user is not authorized to add administrators to a security group
404 (Not Found)	if the specified security group, or one of the specified users, is not found

Add the specified people as regular members of the specified security group. If any error occurs while adding a particular user, all adds will be rolled back.

Availability:

Available to Jive admins only

Path Parameters:

Name	Type	Required	Description
securityGroupID	String	true	ID of the security group to which regular members should be added

Takes:

URIs of the people to be added as regular members. Limit the number of URIs per call to 200.

Return Status:

HTTP Status Code	Description
201 (Created)	Request was successful
400 (Bad Request)	An input field is missing or malformed
409 (Conflict)	A person is added as both an administrator and a regular member
403 (Forbidden)	The requesting user is not authorized to add regular members to a security group
404 (Not Found)	The specified security group, or one of the specified users, is not found

Create and return a security group based on the specified security group entity. Upon success, return a security group entity representing the new security group with all available fields.

The minimum information needed to create a new security group is as follows:

  {
      "name" : "{name}"
  }
 

Availability:

Available to Jive admins only

Query Parameters:

Name	Type	Required	Description
fields	String	false	The fields to include in the returned entity

Takes:

SecurityGroup containing our group information

Retrieves:

SecurityGroup

Return Status:

HTTP Status Code	Description
201 (Created)	Request was successful
400 (Bad Request)	if any of the input fields are malformed
409 (Conflict)	if the requested group would violate the uniqueness constraint on security group names
403 (Forbidden)	if the requesting user is not authorized to create security groups

Remove the specified person as an administrator of the specified security group.

Availability:

Available to Jive admins only

Path Parameters:

Name	Type	Required	Description
securityGroupID	String	true	ID of the security group for which to remove an administrator
personID	String	true	ID of the person to be removed as an administrator

Return Status:

HTTP Status Code	Description
204 (No Content)	Request was successful
400 (Bad Request)	if any of the input fields are malformed
409 (Conflict)	if the specified person is not currently an administrator of the specified security group
403 (Forbidden)	if the requesting user is not authorized to remove administrators
404 (Not Found)	if the specified security group or person is not found

Remove the specified person as a regular member of the specified security group.

Availability:

Available to Jive admins only

Path Parameters:

Name	Type	Required	Description
securityGroupID	String	true	ID of the security group for which to remove a regular member
personID	String	true	ID of the person to be removed as a regular member

Return Status:

HTTP Status Code	Description
204 (No Content)	Request was successful
400 (Bad Request)	An input field is missing or malformed
409 (Conflict)	The specified person is not currently a regular member of the specified security group
403 (Forbidden)	The requesting user is not authorized to remove regular members
404 (Not Found)	The specified security group or person is not found

Delete the specified security group.

Availability:

Available to Jive admins only

Path Parameters:

Name	Type	Required	Description
securityGroupID	String	true	ID of the security group to be deleted

Return Status:

HTTP Status Code	Description
204 (No Content)	Request was successful
400 (Bad Request)	if any of the input fields are malformed
403 (Forbidden)	if the requesting user is not authorized to delete security groups
404 (Not Found)	if the specified security group does not exist

Return nothing if the specified person is an administrator of the specified security group, else throw NotFoundException.

Availability:

Available to Jive admins only

Path Parameters:

Name	Type	Required	Description
securityGroupID	String	true	ID of the security group to be checked
personID	String	true	ID of the person to be checked

Return Status:

HTTP Status Code	Description
204 (No Content)	Request was successful
400 (Bad Request)	An input field is missing or malformed
403 (Forbidden)	The requesting user is not authorized to retrieve this information
404 (Not Found)	The specified person is not an administrator of the specified security group

Return the specified fields in a paginated list of administrators of the specified security group.

Availability:

Available to Jive admins only

Path Parameters:

Name	Type	Required	Description
securityGroupID	String	true	ID of the security group for which administrators are to be returned

Query Parameters:

Name	Type	Required	Description
startIndex	Integer	false	Zero-relative index of the first matching administrator to be returned (default is 0)
count	Integer	false	Maximum number of administrators to be returned (default is 25)
fields	String	false	Fields to be returned (default is @summary)

Retrieves:

Person[] listing the administrators of the requested security group

Return Status:

HTTP Status Code	Description
200 (OK)	Request was successful
400 (Bad Request)	if any of the input fields are malformed
403 (Forbidden)	if the requesting user is not authorized to retrieve security groups information
404 (Not Found)	if the specified security group does not exist

Return nothing if the specified person is a regular member of the specified security group, else throw NotFoundException.

Availability:

Available to Jive admins only

Path Parameters:

Name	Type	Required	Description
securityGroupID	String	true	ID of the security group to be checked
personID	String	true	ID of the person to be checked

Return Status:

HTTP Status Code	Description
204 (No Content)	Request was successful
400 (Bad Request)	An input field is missing or malformed
403 (Forbidden)	The requesting user is not authorized to retrieve this information
404 (Not Found)	The specified person is not a regular member of the specified security group

Return the specified fields in a paginated list of regular members of the specified security group.

Availability:

Available to Jive admins only

Path Parameters:

Name	Type	Required	Description
securityGroupID	String	true	ID of the security group for which regular members are to be returned

Query Parameters:

Name	Type	Required	Description
startIndex	Integer	false	Zero-relative index of the first matching regular member to be returned (default is 0)
count	Integer	false	Maximum number of regular members to be returned (default is 25)
fields	String	false	Fields to be returned (default is @summary)

Retrieves:

Person[] listing the regular members of this security group

Return Status:

HTTP Status Code	Description
200 (OK)	Request was successful
400 (Bad Request)	An input field is missing or malformed
403 (Forbidden)	The requesting user is not authorized to retrieve security groups information
404 (Not Found)	The specified security group does not exist

Return the specified fields in an entity for the specified security group.

Availability:

Available to Jive admins only

Path Parameters:

Name	Type	Required	Description
securityGroupID	String	true	ID of the security group to be returned

Query Parameters:

Name	Type	Required	Description
fields	String	false	Fields to be returned (default value is @standard)

Retrieves:

SecurityGroup

Return Status:

HTTP Status Code	Description
200 (OK)	Request was successful
400 (Bad Request)	Any of the input fields are malformed
403 (Forbidden)	The requesting user is not authorized to retrieve security groups
404 (Not Found)	The specified security group does not exist

Return a SecurityGroup whose name matches the specified name.

Availability:

Available to Jive admins only

Path Parameters:

Name	Type	Required	Description
name	String	true	name of the security group to be returned

Query Parameters:

Name	Type	Required	Description
fields	String	false	Fields to be returned for each security group (default value is @standard)

Retrieves:

SecurityGroup

Return Status:

HTTP Status Code	Description
200 (OK)	Request was successful
404 (Not Found)	if the name does not match a valid security group
403 (Forbidden)	The requesting user is not authorized to retrieve security groups

Since: 3.1

Return the specified fields in a paginated list of security groups that match the specified selection criteria (or all security groups if no criteria are specified).

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.

Filter	Params	Example
updated	One or two timestamps in ISO-8601 format. If one timestamp is specified, all security groups updated since that timestamp will be selected. If two timestamps are specified, all security groups updated in the specified range will be selected.	?filter=updated(2012-01-31T22:46:12.044%2B0000,2012-12-03T22:46:12.044%2B0000)

This service supports the following sort types.

Sort	Description
nameAsc	Sort by name in ascending order. This is the default sort order.
updatedAsc	Sort by the date this security group was most recently updated, in ascending order.

Availability:

Available to Jive admins only

Query Parameters:

Name	Type	Required	Description
filter	Object[]	false	The filter criteria used to select security groups. Since 3.6.
startIndex	Integer	false	Zero-relative index of the first matching security group to be returned (default value is 0)
count	Integer	false	Maximum number of security groups to be returned (default value is 25)
fields	String	false	Fields to be returned for each security group (default value is @standard)
sort	String	false	Optional sort to apply to the search results. Since 3.6.

Retrieves:

SecurityGroup[]

Return Status:

HTTP Status Code	Description
200 (OK)	Request was successful
400 (Bad Request)	Any of the input fields are malformed
403 (Forbidden)	The requesting user is not authorized to retrieve security groups

Update an existing security group based on the specified security group entity. Upon success, return a security group entity representing the updated security group with all available fields.

Availability:

Available to Jive admins only

Path Parameters:

Name	Type	Required	Description
securityGroupID	String	true	ID of the security group to be updated

Takes:

SecurityGroup containing our group information

Retrieves:

SecurityGroup reflecting the updated security group

Return Status:

HTTP Status Code	Description
200 (OK)	Request was successful
400 (Bad Request)	if any of the input fields are malformed
409 (Conflict)	if the requested group would violate the uniqueness constraint on security group names
403 (Forbidden)	if the requesting user is not authorized to update security groups
404 (Not Found)	if the requested security group does not exist