Permission

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

Overview

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) required  
permittedEntityDescription string
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
/nsredundantports/id/permissions
get post
/domains/id/permissions
get post
/gateways/id/permissions
get post
/services/id/permissions
get post
/l2domains/id/permissions
get post
/nsgateways/id/permissions
get post
/l2domaintemplates/id/permissions
get post
/domaintemplates/id/permissions
get post
/nsgredundancygroups/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

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 required  
Discussion

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

Charateristics

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

permittedEntityDescription string
Discussion

Description for the permittedEntity

Charateristics

Format: free
SDK attribute: permittedEntityDescription

permittedEntityID string required  
Discussion

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

Charateristics

Format: free
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