EnterprisePermission

Represents Enterprise Permission for a CSP entity.

Overview

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) required  
permittedEntityDescription string
permittedEntityID string
permittedEntityName string
permittedEntityType string

API Resource

/enterprisepermissions/id
delete get put

Parents

/sharednetworkresources/id/enterprisepermissions
get post
/ports/id/enterprisepermissions
get post
/redundancygroups/id/enterprisepermissions
get post
/vsgredundantports/id/enterprisepermissions
get post
/gatewayredundantports/id/enterprisepermissions
get post
/patnatpools/id/enterprisepermissions
get post
/nsredundantports/id/enterprisepermissions
get post
/subnets/id/enterprisepermissions
get post
/netconfgateways/id/enterprisepermissions
get post
/gateways/id/enterprisepermissions
get post
/services/id/enterprisepermissions
get post
/nsgateways/id/enterprisepermissions
get post
/nsgredundancygroups/id/enterprisepermissions
get post
/vlans/id/enterprisepermissions
get post
/nsports/id/enterprisepermissions
get post

Children

/enterprisepermissions/id/metadatas
get post
/enterprisepermissions/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

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

The permitted action.

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
Discussion

The enterprise permitted to use/extend this Gateway

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