SecurityGroup

Entity representing a Jive security group.

Example:
Example JSON

JSON including important fields and a SecurityGroup's resources. See the tables below for a list of all fields and resources.

  {
    "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,
    "id" : "1001",
    "resources" : {
      "administrators" : {
        "ref" : "https://example.jiveon.com/api/core/v3/securityGroups/1001/administrators",
        "allowed" : [ "POST", "GET" ]
      },
      "self" : {
        "ref" : "https://example.jiveon.com/api/core/v3/securityGroups/1001",
        "allowed" : [ "DELETE", "PUT", "GET" ]
      },
      "members" : {
        "ref" : "https://example.jiveon.com/api/core/v3/securityGroups/1001/members",
        "allowed" : [ "POST", "GET" ]
      }
    }
  }

Fields

FieldTypeMode †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").

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

Resources

ResourceMethodDescription
administratorsGET

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

Availability:

Available to Jive admins only

Retrieves:
  • Person[]
    • administratorsPOST

    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
    htmlGET

    URI of the HTML representation of this security group.

    membersGET

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

    Availability:

    Available to Jive admins only

    Retrieves:
  • Person[]
    • membersPOST

    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
    selfGET

    Return an updated version of this security group.

    Availability:

    Available to Jive admins only

    Retrieves:
  • SecurityGroup representing the updated security group
    • selfPUT

    Update the information about this security group.

    Availability:

    Available to Jive admins only

    Retrieves:
  • SecurityGroup representing the updated security group
    • selfDELETE

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

    Availability:

    Available to Jive admins only