List Roles

GET

https://Example-Server.com/be/v1/roles

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

This endpoint allows you to list the details of all roles of your organiztion on the ROCKIT Edge.

Required Permissions

roles.read

See Roles for more details.

Request

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?offset=0&limit=10&fields[]=name&fields[]=label&fields[]=created&fields[]=updated&name=example_app&processing=true&exporting=true&order[]=-updated' \
--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",
    "totalCount": 2,
    "roles": [
        {
            "_id": "67f3ea103a94ce31ce20ce50",
            "orgName": "KuhlmannOrg",
            "name": "Administrators",
            "perms": {
                "apps": 15,
                "beUsers": 15,
                "bundles": 31,
                "consumption": 2,
                "dependencies": 15,
                "deployments": 15,
                "keys": 15,
                "orgs": 15,
                "roles": 15,
                "sources": 15,
                "subscriptions": 15,
                "tasks": 31,
                "trainings": 6
            },
            "nUsers": 9
        },
        {
            "_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
        }
    ]
}

🟠400400: missing-param

🟠401401: token-expired

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

Roles

Create Role

List Roles

Required Permissions#

Request

Request Code Samples

Responses

Required Permissions