Permission

User groups that are granted permissions for objects such as domains, zones, and subnets can see and manipulate everything within the object.

Overview

associatedGroupDescription string
associatedGroupID string
associatedGroupName string
associatedRoleDescription string filterable   orderable  
associatedRoleID string filterable   orderable  
associatedRoleName string filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string filterable   orderable  
permittedAction enum (ALL | DEPLOY | EXTEND | INSTANTIATE | READ | USE)
permittedEnterpriseDescription string filterable   orderable  
permittedEnterpriseName string filterable   orderable  
permittedEntityID string required  
permittedEntityName string
permittedEntityType string

API Resource

/permissions/id
delete get put

Parents

/ports/id/permissions
get post
/redundancygroups/id/permissions
get post
/vsgredundantports/id/permissions
get post
/zones/id/permissions
get post
/gatewayredundantports/id/permissions
get post
/nsredundantports/id/permissions
get post
/netconfgateways/id/permissions
get post
/domains/id/permissions
get post
/gateways/id/permissions
get post
/services/id/permissions
get post
/l2domains/id/permissions
get post
/ethernetsegmentgroups/id/permissions
get post
/nsgateways/id/permissions
get post
/aggregateddomains/id/permissions
get post
/l2domaintemplates/id/permissions
get post
/domaintemplates/id/permissions
get post
/nsgredundancygroups/id/permissions
get post
/ethernetsegmentgwgroups/id/permissions
get post
/vlans/id/permissions
get post
/nsports/id/permissions
get post

Children

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

Members

This object has no members.

Attributes documentation

associatedGroupDescription string
Discussion

Description of the Group

Charateristics

Format: free
SDK attribute: associatedGroupDescription

associatedGroupID string
Discussion

The Group ID associated with this permission.

Charateristics

Format: free
SDK attribute: associatedGroupID

associatedGroupName string
Discussion

Name of the group for which we have given permission.

Charateristics

Format: free
SDK attribute: associatedGroupName

associatedRoleDescription string filterable   orderable  
Discussion

Description of the role asssociated with the permission

Charateristics

Format: free
Max length: 255
SDK attribute: associatedRoleDescription

associatedRoleID string filterable   orderable  
Discussion

ID of the associated Role

Charateristics

Format: free
Max length: 255
SDK attribute: associatedRoleID

associatedRoleName string filterable   orderable  
Discussion

Associated Role Name

Charateristics

Format: free
Max length: 255
SDK attribute: associatedRoleName

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

name string filterable   orderable  
Discussion

Name of the Permission

Charateristics

Format: free
Max length: 255
SDK attribute: name

permittedAction enum
Discussion

The permitted action to USE/EXTEND/READ/INSTANTIATE an entity.

Charateristics

Allowed values: ALL, DEPLOY, EXTEND, INSTANTIATE, READ, USE
SDK attribute: permittedAction

permittedEnterpriseDescription string filterable   orderable  
Discussion

Name of the permitted Enterprise

Charateristics

Format: free
Max length: 255
SDK attribute: permittedEnterpriseDescription

permittedEnterpriseName string filterable   orderable  
Discussion

Name of the associated Enterprise

Charateristics

Format: free
Max length: 255
SDK attribute: permittedEnterpriseName

permittedEntityID string required  
Discussion

The entity ID for which this permission action is associated against.

Charateristics

Format: free
Max length: 255
SDK attribute: permittedEntityID

permittedEntityName string
Discussion

Name of the entity for which we have given permission.

Charateristics

Format: free
SDK attribute: permittedEntityName

permittedEntityType string
Discussion

Type of the entity for which we have given permission.

Charateristics

Format: free
SDK attribute: permittedEntityType