Acceldata
Pulse

Last updated: Sep 27, 2026 15:10 UTC

API to Create Roles

The following describes the method to input Roles to the user interface (UI).

  • Select any API testing tool to invoke an API.
  • Include the additional JSON Web Token (JWT) header for authentication in the request, which is obtained during logging in to the API testing tool.
  • Include the following argument:

Method -

{
    "localUsers" : [ ],                                                                               -  optional
    "adGroupsMapped" : [ ],                                                                     -  optional
    "adUsersMapped" : [ ],                                                                          -  optional
    "clusters" : [ <list of cluster names>],                                                    -  required
    "name" : “<role name>",                                                                       -  required
    "serviceQueues" : {                                                                             -  required
        “<cluster name 1>" : [<list of yarn queues>],
        “<cluster name 2>" : [<list of yarn queues>],
        .
        .
    },
    "serviceUsers" : {                                                                               -  required
        “<cluster name 1>" : [<list yarn users>],
        “<cluster name 2>" : [<list yarn users>],
        .
        .
    },
    "impalaUsers" : {                                                                                   -  required if impala
        “<cluster name 1>" : [<list of impala users>],
        “<cluster name 2>" : [<list of impala users>]
        .
        .
    },
    "permissions" : {                                                                                   -  required
        “<component name>”: true/false,
        .
        .
    }
}

The following is the list of available components for permissions:

"dashboard" : true,
        "studio" : true,
        "dashplots" : true,
        "hdfs" : true,
        "yarn" : true,
        "spark-thrift" : true,
        "mr" : true,
        "tez" : true,
        "llap" : true,
        "hiveOnSpark" : true,
        "spark" : true,
        "hbase" : true,
        "kafka" : true,
        "ni fi" : true,
        "druid" : true,
        "impala" : true,
        "memsql" : true,
        "chargeback-reports" : true,
        "applications-explorer" : true,
        "databases" : true,
        "nodes" : true,
        "logs" : true,
        "alerts" : true,
        "actions" : true,
        "hdfs~fsanalytics" : true,
        "hdfs~ fileExplorer" : true,
        "yarn~services" : true,
        "spark-thrift~queries" : true,
        "spark-thrift~tables" : true,
        "spark-thrift~reports" : true,
        "mr~mr-queries" : true,
        "mr~mr-tables" : true,
        "tez~tez-queries" : true,
        "tez~tez-tables" : true,
        "llap~llap-daemons" : true,
        "llap~llap-queries" : true,
        "llap~llap-tables" : true,
        "llap~llap-reports" : true,
        "hiveOnSpark~hiveOnSparkQueries" : true,
        "hiveOnSpark~hiveOnSparkTables" : true,
        "spark~spark-jobs" : true,
        "spark~spark-streams" : true,
        "hbase~regions" : true,
        "hbase~tables" : true,
        "hbase~snapshot" : true,
        "hbase~proctor" : true,
        "hbase~services" : true,
        "kafka~topics" : true,
        "kafka~brokers" : true,
        "kafka~consumers" : true,
        "ni fi~process-groups" : true,
        "ni fi~flow-files" : true,
        "druid~services" : true,
        "druid~queries-dashboard" : true,
        "impala~impala-queries" : true,
        "impala~impala-tables" : true,
        "impala~impala-daemons" : true,
        "memsql~queries" : true,
        "memsql~user-queries" : true,
        "memsql~plan" : true,
        "memsql~tables" : true,
        "memsql~pipelines" : true,
        "chargeback-reports~nodelabels" : true,
        "databases~hivefsanalytics" : true,
        "alerts~incidents" : true,
        "actions~executions" : true,
        "spark-thrift~kpi~view" : true,
        "spark-thrift~kpi~createEdit" : true,
        "mr~kpi~view" : true,
        "mr~kpi~createEdit" : true,
        "tez~kpi~view" : true,
        "tez~kpi~createEdit" : true,
        "hiveOnSpark~kpi~view" : true,
        "hiveOnSpark~kpi~createEdit" : true,
        "spark~kpi~view" : true,
        "spark~kpi~createEdit" : true,
        "druid~queries-dashboard~queries" : true,
        "memsql~pipelineruns" : true,
        "memsql~pipeline files" : true,
        "alerts~kpi~view" : true,