Resolve permissions for custom roles | Comp AI API

Returns the merged permissions for the given custom role names. Used by the frontend to resolve effective permissions for users with custom roles.

GET /v1/roles/permissions

Resolve permissions for custom roles

cURL

curl --request GET \
  --url https://api.trycomp.ai/v1/roles/permissions \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.trycomp.ai/v1/roles/permissions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.trycomp.ai/v1/roles/permissions"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "permissions": {}
}

Authorizations

X-API-Key · string · header · required

API key for authentication

Query Parameters

roles · string · required

Response

200

application/json

Merged permissions for the requested roles

permissions · object

Show child attributes