ROCKITPLAY API
  1. Roles
ROCKITPLAY API
  • ROCKIT Edge - Admin API
    • Minimal Tests
      • ping
      • submit test task
    • Admin Edge Organizations
      • Create Organization
      • Delete Organization
  • ROCKIT Edge - Backend API
    • Backend Edge Organizations
      • Create Organization
      • Delete Organization
    • Authentication
      • user login
      • authentication
    • Account Management
      • get user details
      • list users
      • Modify user
      • delete users
      • Create User / Create Machine User
    • Deployments
      • Creating Deployments
      • Get Deployments
      • Get Deployment Details
      • Modify Deployment
      • Deleting Deployments
    • Apps
      • Creating Apps
      • Import native builds
      • App Details
      • List Apps
      • patch app
      • Delete Apps
    • Triggers
      • Process Traces
      • Retry Task
    • Tasks
      • Listing Tasks
      • Task Details
      • Acknowledge Warning / Expire Task
    • Subscriptions
      • Subscribe
      • List Subscriptions
      • Unsubscribe
    • Roles
      • List Roles
        GET
      • Create Role
        POST
      • Patch Role
        PATCH
      • Role Details
        GET
      • Delete Roles
        DELETE
  • Changelog
    • Changelog
  1. Roles

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
offset
integer 
optional
Pagination offset.
>= 0
Example:
0
limit
integer 
optional
Pagination limit.
>= 1
Default:
10
Example:
10
fields[]
array[string]
optional
Comma-separated list of fields to include in the response. Supported fields are: name,label,iCurBuild,maxBuilds,processing,exporting,sizeBytes,created,updated,shortcut,execPath,deployments,files,appDataPath,nKeys,nTraces
Example:
["name","label","created","updated"]
name
string 
optional
Filter by app name (supports partial matches, case sensitive).
Example:
example_app
processing
boolean 
optional
Filter by processing status.
Example:
true
exporting
boolean 
optional
Filter by exporting status.
Example:
true
order[]
array[string]
optional
Sorting order. Supported fields for sorting: name,label,created,updated. +/- for Ascending/Descending (no +/- results in ascending order)
Example:
-updated
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:
{{_edge_org_admin_beauth_token}}
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:
{{EDGE_ORG_NAME}}
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:
{{_adminPrincipal_apiKey}}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
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
status
string 
required
Indicates that the retrieval of the app list was successful.
totalCount
integer 
required
roles
array [object {5}] 
required
_id
string 
required
orgName
string 
required
name
string 
required
perms
object 
required
nUsers
integer 
required
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
Previous
Roles
Next
Create Role
Built with