Role Data Type

Type describing the Waterline Data access model for users. Roles include an access level, one or more data sources, and one or more tag domains.

Abstract Type
Properties
name data type description
domainKeys array of string List of tag domains accessible to users with this role. Specify an empty list to indicate all tag domains.
dataSourceKeys array of string List of data sources accessible to users with this role. Specify an empty list to indicate all data sources.
virtualFolderKeys array of string List of logical folders accessible to users with this role. Specify an empty list to indicate all data sources.
accessLevel AccessLevel Access level. One of "Guest", "Analyst", "Steward", or "Administrator".
jobExecutionAllowed boolean
jobTemplateCreationAllowed boolean
name string Role name.
defaultRole boolean
resourceReadAccessLevel string
datasetKeys array of string
Properties inherited from Entity
key string
type string
description string
timeOfLastChange number
timeOfCreation number
restricted array of string
updateable array of string
viewAble array of string
customProperties array of CustomProperty

Example

This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.
{
  "domainKeys" : [ "...", "..." ],
  "dataSourceKeys" : [ "...", "..." ],
  "virtualFolderKeys" : [ "...", "..." ],
  "accessLevel" : "Steward",
  "jobExecutionAllowed" : true,
  "jobTemplateCreationAllowed" : true,
  "name" : "...",
  "defaultRole" : true,
  "resourceReadAccessLevel" : "...",
  "datasetKeys" : [ "...", "..." ],
  "key" : "...",
  "type" : "...",
  "description" : "...",
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "restricted" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "customProperties" : [ {
    "displayName" : "...",
    "value" : { },
    "description" : "...",
    "facetAble" : true,
    "name" : "...",
    "type" : "..."
  }, {
    "displayName" : "...",
    "value" : { },
    "description" : "...",
    "facetAble" : true,
    "name" : "...",
    "type" : "..."
  } ]
}