Group

Identifies a group within an enterprise

Overview

accountRestrictions boolean
creationDate string read only   autogenerated   orderable  
description string filterable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
LDAPDomain string read only  
LDAPGroupDN string orderable  
LDAPId string read only   filterable   orderable  
managementMode enum (CMS | DEFAULT | RESERVED)
name string required   filterable   orderable  
owner string autogenerated  
private boolean filterable   orderable  
restrictionDate time
role enum (ADMINOPERATOR | AUDITADMIN | CMS | CSPOPERATOR | CSPROOT | JMS | NETCONFMGR | ORGADMIN | ORGNETWORKDESIGNER | ORGUSER | POSTACTIVATION | PREACTIVATION | SECURITYADMINISTRATOR | STATS | SYSTEM | UNKNOWN | USER) filterable   orderable  

API Resource

/groups/id
delete get put

Parents

/enterprises/id/groups
get post
/zones/id/groups
get put
/domains/id/groups
get put
/l2domains/id/groups
get put
/aggregateddomains/id/groups
get put
/l2domaintemplates/id/groups
get put
/domaintemplates/id/groups
get put
/users/id/groups
get

Children

/groups/id/permissions
delete get post put
/groups/id/metadatas
get post
/groups/id/globalmetadatas
get post put
/groups/id/eventlogs
get

Members

/groups/id/users
get put

Attributes documentation

accountRestrictions boolean
Discussion

Determines whether group is disabled or not.

Charateristics

SDK attribute: accountRestrictions

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

description string filterable  
Discussion

Description of the group

Charateristics

Format: free
Max length: 255
SDK attribute: description

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

Charateristics

SDK attribute: embeddedMetadata

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.

Charateristics

SDK attribute: lastUpdatedDate

LDAPDomain string read only  
Discussion

The domain name of the LDAP instance from which the group was synchronized.

Charateristics

Format: free
Max length: 255
SDK attribute: LDAPDomain

LDAPGroupDN string orderable  
Discussion

The LDAP distinguished name (DN) for the group.

Charateristics

Format: free
SDK attribute: LDAPGroupDN

LDAPId string read only   filterable   orderable  
Discussion

The ID of the LDAP instance from which the group was synchronized.

Charateristics

Format: free
Max length: 255
SDK attribute: LDAPId

managementMode enum
Discussion

Management mode of the user object - allows for override of external authorization and syncup

Charateristics

Allowed values: CMS, DEFAULT, RESERVED
SDK attribute: managementMode

name string required   filterable   orderable  
Discussion

A unique name of the group

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: name

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner

private boolean filterable   orderable  
Discussion

A private group is visible only by the owner of the group. Public groups are visible by all users in the enterprise

Charateristics

SDK attribute: private

restrictionDate time
Discussion

When the group was disabled.

Charateristics

SDK attribute: restrictionDate

role enum filterable   orderable  
Discussion

The role associated with this group.

Charateristics

Allowed values: ADMINOPERATOR, AUDITADMIN, CMS, CSPOPERATOR, CSPROOT, JMS, NETCONFMGR, ORGADMIN, ORGNETWORKDESIGNER, ORGUSER, POSTACTIVATION, PREACTIVATION, SECURITYADMINISTRATOR, STATS, SYSTEM, UNKNOWN, USER
SDK attribute: role