List available permissions

GET

/api/v1/organizations/{orgId}/roles/permissions

const url = 'http://localhost:3000/api/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/roles/permissions';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:3000/api/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/roles/permissions \
  --header 'X-API-Key: <X-API-Key>'

Retrieves all available permissions for role creation.

Authorizations

api-key
bearer

Parameters

Path Parameters

orgId

required

string format: uuid

Organization UUID

Responses

200

Permissions retrieved successfully

application/json

object

permissions

required

List of available permissions

Array<object>

object

key

required

Unique permission key

string

name

required

Human-readable permission name

string

description

required

Permission description

string

category

required

Permission category for grouping

string

Example

{
  "permissions": [
    {
      "key": "devices:write",
      "name": "Write Devices",
      "description": "Allows creating, updating, and deleting devices",
      "category": "Devices"
    }
  ]
}

401

Unauthorized

403

Forbidden - Insufficient permissions