Get role by ID

GET

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

const url = 'http://localhost:3000/api/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/roles/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
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/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'X-API-Key: <X-API-Key>'

Retrieves a specific role by its unique identifier.

Authorizations

api-key
bearer

Parameters

Path Parameters

required

string format: uuid

Role UUID

orgId

required

string format: uuid

Organization UUID

Header Parameters

x-organization-id

string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Responses

200

Role retrieved successfully

application/json

object

required

Unique role identifier

string format: uuid

name

required

Role display name

string

description

Role description

string

permissions

required

List of permission keys assigned to this role

Array<string>

isSystem

required

Whether this is a system-defined role (cannot be modified)

boolean

organizationId

Organization ID (null for system roles)

string format: uuid

createdAt

required

When the role was created

string format: date-time

updatedAt

required

When the role was last updated

string format: date-time

Example

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Device Operator",
  "description": "Can view and manage devices but not deployments",
  "permissions": [
    "devices:read",
    "devices:write",
    "deployments:read"
  ],
  "isSystem": false,
  "organizationId": "550e8400-e29b-41d4-a716-446655440001",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-06-20T14:45:00Z"
}

401

Unauthorized

403

Forbidden - Insufficient permissions

404

Role not found