osapi.jive.corev3.admin.SecurityGroup

Entity representing a Jive security group.

Example:
Example JSON

JSON with the most important data for a SecurityGroup. See the table below for a list of all fields.

  {
    "name" : "My First Group",
    "description" : "This is a security group.",
    "published" : "2012-01-07T02:30:08.714+0000",
    "updated" : "2012-01-07T02:31:09.274+0000",
    "federated" : false
  }

Properties

PropertyTypeMode Description
administratorCountIntegerread-only

Number of administrative members in this security group.

descriptionStringoptional

Description of this security group.

federatedBooleanoptional

Flag indicating that the membership of this group is federated with an external directory service.

idStringread-only

Identifier (unique within an object type and Jive instance) of this object. This field is internal to Jive and should not be confused with contentID or placeID used in URIs.

memberCountIntegerread-only

Number of regular members of this security group.

nameStringrequired

Name of this security group.

propertiesObjectoptional

Extended properties of this security group.

publishedISO 8601 Dateread-only

Date and time this security group was initially created.

resourcesObjectread-only

Resource links (and related permissions for the requesting person) relevant to this object.

tagsString[]optional

Tags associated with this object.

Availability:

Will be present only for object types that support tags

typeStringread-only

Object type of this object ("securityGroup").

typeCodeIntegerread-only
updatedISO 8601 Dateread-only

Date and time this security group was last updated.

→ Fields used by update and create operations
→ Fields used only by create operations
→ Fields not used by update or create operations

Methods

createAdministrators(list)
POST /securityGroups/1234/administrators

Retrieves

--

Description

Add one or more new administrators to this security group.

Availability:

Available to Jive admins only

Takes:
  • An array of URIs of the people to be added
createMembers(list)
POST /securityGroups/1234/members

Retrieves

--

Description

Add one or more new regular members to this security group.

Availability:

Available to Jive admins only

Takes:
  • An array of URIs of the people to be added
destroy()
DELETE /securityGroups/1234

Retrieves

--

Description

Delete this security group and all of its administrative and regular members.

Availability:

Available to Jive admins only

get(options)
GET /securityGroups/1234

Retrieves

SecurityGroup

Description

Return an updated version of this security group.

Availability:

Available to Jive admins only

Options:
NameTypeRequiredDescription
fieldsStringfalseThe names of the fields to be returned
Retrieves:
  • SecurityGroup representing the updated security group
  • getAdministrators(options)
    GET /securityGroups/1234/administrators

    Retrieves

    Person[]

    Description

    Return a paginated list of the administrative members of this security group.

    Availability:

    Available to Jive admins only

    Options:
    NameTypeRequiredDescription
    countIntegerfalseThe maximum number of members to return (default is 25)
    fieldsStringfalseThe names of the fields to be returned
    startIndexIntegerfalseZero-relative index of the first member to return (default is 0)
    Retrieves:
  • Person[]
  • getMembers(options)
    GET /securityGroups/1234/members

    Retrieves

    Person[]

    Description

    Return a paginated list of regular members of this security group.

    Availability:

    Available to Jive admins only

    Options:
    NameTypeRequiredDescription
    countIntegerfalseThe maximum number of members to return (default is 25)
    fieldsStringfalseThe names of the fields to be returned
    startIndexIntegerfalseZero-relative index of the first member to return (default is 0)
    Retrieves:
  • Person[]
  • toURI()

    Retrieves

    String

    Description

    Retrieves:
  • A URI representing this entity, or undefined if no such URI exists.
  • update(securitygroupentity)
    PUT /securityGroups/1234

    Retrieves

    SecurityGroup

    Description

    Update the information about this security group.

    Availability:

    Available to Jive admins only

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseThe names of the fields to be returned
    Retrieves:
  • SecurityGroup representing the updated security group
  • Resources

    ResourceMethodReturnsDescription
    htmlGETObject

    URI of the HTML representation of this security group.