static osapi.jive.corev3.securityGroups

Static class for getting and creating Security Groups.

Methods

create(securitygroup,options)
POST /securityGroups

Retrieves

SecurityGroup

Description

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:
Options:
NameTypeRequiredDescription
fieldsStringfalseNames of the fields to be returned
Retrieves:
  • SecurityGroup describing the newly created security group
  • get(options)
    GET /securityGroups

    Retrieves

    SecurityGroup[]

    Description

    Return a paginated list of security groups defined in this Jive instance.

    Availability:

    Available to Jive admins only

    Options:
    NameTypeRequiredDescription
    countIntegerfalseThe maximum number of security groups to return (default is 25)
    fieldsStringfalseThe names of the fields to be returned
    startIndexIntegerfalseZero-relative index of the first security group to return (default is 0)
    Retrieves:
  • SecurityGroup[]
  • get(options)
    GET /securityGroups/name/{name}

    Retrieves

    SecurityGroup

    Description

    Return the specified security group by its name.

    Availability:

    Available to Jive admins only

    Options:
    NameTypeRequiredDescription
    nameStringtruethe name of the security group to be returned
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • SecurityGroup describing the specified security group
  • Since: 3.1
    get(options)
    GET /securityGroups/{uri}

    Retrieves

    SecurityGroup

    Description

    Return the specified security group by its URI.

    Availability:

    Available to Jive admins only

    Options:
    NameTypeRequiredDescription
    uriStringtrueURI of the requested security group
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • SecurityGroup describing the specified security group
  • getMembers(options)
    GET /securityGroups/{securityGroupID}/members

    Retrieves

    Person[]

    Description