Role Details

Request

Path Params

roleName

string

required

Query Params

fields[]

array[string]

optional

String array of fields to include in the response.

Example:

["name"]

Header Params

x-rockit-beauth-token

string

optional

ROCKIT Edge backend authentication token (POST /be/v1/auth) or API key (POST /be/v1/apikeys)
Mutually excluded with x-rockit-api-key.

Example:

x-rockit-orgname

string

optional

Unique and immutable organization identifier obtained from the ROCKIT Edge administrator.
Requires x-rockit-username and x-rockit-api-key.

Example:

x-rockit-username

string

optional

Unique and immutable username which is accociated with the apikey.
Requires x-rockit-orgname and x-rockit-api-key.

Example:

adminPrincipal

x-rockit-api-key

string

optional

Unique and imuutable apikey which is accociated with an machine user.
Mutually excluded with x-rockit-beauth-token. Requires x-rockit-username and x-rockit-orgname.

Example:

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request GET 'https://Example-Server.com/be/v1/roles/?fields[]=name' \
--header 'x-rockit-beauth-token: eyjhvcIhvds;huVODV...' \
--header 'x-rockit-orgname: ExampleOrg' \
--header 'x-rockit-username: adminPrincipal' \
--header 'x-rockit-api-key: {{_adminPrincipal_apiKey}}'

Responses

🟢200OK

application/json

Body

status

string

required

Indicates that the app details were retrieved successfully.

role

object

required

_id

string

required

orgName

string

required

name

string

required

perms

object

required

nUsers

integer

required

users

array[string]

required

Example

{
  "status": "success",
  "role": {
    "_id": "681a14514752913f25d9af12",
    "orgName": "KuhlmannOrg",
    "name": "exampleRole",
    "perms": {
      "apps": 12,
      "beUsers": 7,
      "bundles": 11,
      "consumption": 2,
      "dependencies": 4,
      "deployments": 11,
      "keys": 15,
      "orgs": 0,
      "roles": 9,
      "sources": 8,
      "subscriptions": 4,
      "tasks": 31,
      "trainings": 3
    },
    "nUsers": 0,
    "users": []
  }
}

🟠400400: missing-param

🟠401401: token-expired

Required Permissions#

Request

Request samples

Responses

Required Permissions