Roleentry

Entry for each end point with assoicatiated permissions.

Overview

embeddedMetadata list read only   autogenerated  
endPointType string required   filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
roleAccessTypeList list (CREATE | CUD_CHILDREN | DELETE | MODIFY | NO_ACCESS | NO_ACCESS_CHILDREN | READ | READ_CHILDREN) required  

API Resource

/roleentries/id
delete get put

Parents

/roles/id/roleentries
get

Children

/roleentries/id/permissions
delete get post put
/roleentries/id/metadatas
get post
/roleentries/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

endPointType string required   filterable   orderable  
Discussion

Managed Object Type or end point

Charateristics

Min length: 1
Max length: 255
SDK attribute: endPointType

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

roleAccessTypeList list required  
Discussion

List of Access like READ, READ_CHILDREN, CREATE, MODIFY, DELETE, CUD_CHILDREN, NO_ACCESS, NO_ACCESS_CHILDREN

Charateristics

Allowed values: CREATE, CUD_CHILDREN, DELETE, MODIFY, NO_ACCESS, NO_ACCESS_CHILDREN, READ, READ_CHILDREN
SDK attribute: roleAccessTypeList