ApiAuthRole Data Model

This is the model for user role scope in the API since v18. This is used to support granular permissions.

Properties
name data type description
displayName string
name string
clusters array of ApiClusterRef
users array of ApiUser2Ref
externalUserMappings array of ApiExternalUserMappingRef
baseRole ApiAuthRoleRef A role this user possesses. In Cloudera Enterprise Datahub Edition, possible values are:
  • ROLE_ADMIN
  • ROLE_USER
  • ROLE_LIMITED: Added in Cloudera Manager 5.0
  • ROLE_OPERATOR: Added in Cloudera Manager 5.1
  • ROLE_CONFIGURATOR: Added in Cloudera Manager 5.1
  • ROLE_CLUSTER_ADMIN: Added in Cloudera Manager 5.2
  • ROLE_BDR_ADMIN: Added in Cloudera Manager 5.2
  • ROLE_NAVIGATOR_ADMIN: Added in Cloudera Manager 5.2
  • ROLE_USER_ADMIN: Added in Cloudera Manager 5.2
  • ROLE_KEY_ADMIN: Added in Cloudera Manager 5.5
An empty role implies ROLE_USER.

uuid string Readonly. The UUID of the authRole.

isCustom boolean

Example

{
  "displayName" : "...",
  "name" : "...",
  "clusters" : [ {
    "clusterName" : "...",
    "displayName" : "..."
  }, {
    "clusterName" : "...",
    "displayName" : "..."
  } ],
  "users" : [ {
    "name" : "..."
  }, {
    "name" : "..."
  } ],
  "externalUserMappings" : [ {
    "uuid" : "...",
    "name" : "...",
    "type" : "EXTERNAL_PROGRAM"
  }, {
    "uuid" : "...",
    "name" : "...",
    "type" : "SAML_ATTRIBUTE"
  } ],
  "baseRole" : {
    "displayName" : "...",
    "name" : "...",
    "uuid" : "..."
  },
  "uuid" : "...",
  "isCustom" : true
}