API Reference

Retrieve a role

get
https://api.controlup.com/v1/organizations//roles/

Returns the details for a role, including the permissions within the role and the users to which the role is assigned.

Required permission: View Settings

Path Params
uuid
required
^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$

ID of your ControlUp organization. You can find your organization ID on the API Key Management page in the DEX platform.

int32
required
≥ 1

ID of the role to retrieve. You can use GET /roles to see the ID of each role.

Default role IDs:

  • Admin - 1
  • Editor - 2
  • Viewer - 3
  • No Permissions - 4
  • VDI and DaaS Admins - 5
  • Access Real-Time DX Console - 6
Query Params
string
enum
Defaults to json

The format of returned results.

Allowed:
Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?