static osapi.jive.corev3.securityGroups
Static class for getting and creating
Security Groups.Methods
↑
SecurityGroup describing the newly created security group
create(securitygroup,options)
POST /securityGroupsRetrieves
SecurityGroupDescription
Create a new security group, and return a SecurityGroup representing the new object.
The minimum information needed to create a new security group is as follows:
{ "name" : "{name}" }
Availability:
Available to Jive admins only
Takes:
- SecurityGroup fields describing the new security group
Options:
| Name | Type | Required | Description |
|---|---|---|---|
| fields | String | false | Names of the fields to be returned |
Retrieves:
↑
SecurityGroup[]
get(options)
GET /securityGroupsRetrieves
SecurityGroup[]Description
Return a paginated list of security groups defined in this Jive instance.
Availability:
Available to Jive admins only
Options:
| Name | Type | Required | Description |
|---|---|---|---|
| count | Integer | false | The maximum number of security groups to return (default is 25) |
| fields | String | false | The names of the fields to be returned |
| startIndex | Integer | false | Zero-relative index of the first security group to return (default is 0) |
Retrieves:
↑
SecurityGroup describing the specified security group
get(options)
GET /securityGroups/name/{name}Retrieves
SecurityGroupDescription
Return the specified security group by its name.
Availability:
Available to Jive admins only
Options:
| Name | Type | Required | Description |
|---|---|---|---|
| name | String | true | the name of the security group to be returned |
| fields | String | false | Names of the fields to be returned |
Retrieves:
Since: 3.1
↑
SecurityGroup describing the specified security group
get(options)
GET /securityGroups/{uri}Retrieves
SecurityGroupDescription
Return the specified security group by its URI.
Availability:
Available to Jive admins only
Options:
| Name | Type | Required | Description |
|---|---|---|---|
| uri | String | true | URI of the requested security group |
| fields | String | false | Names of the fields to be returned |