Role Details

GET

https://Example-Server.com/be/v1/roles/{roleName}

Last modified:2025-05-07 10:43:38

This endpoint allows you to list the details of a role of your organiztion on the ROCKIT Edge.

Required Permissions

roles.read

See Roles for more details.

Request

Path Params

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

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

Modified at 2025-05-07 10:43:38

Patch Role

Delete Roles

Role Details

Required Permissions#

Request

Request Code Samples

Responses

Required Permissions