OpenAPI

BUILD

Roles

Read built-in and custom organization roles and create custom roles through the management API.

GET/api/organizations/{id}/roles

List roles and permissions

This operation is part of the public Lucion Identity contract.

Safe request
curl -X GET 'https://identity.lucionglobal.com/api/organizations/YOUR_ID/roles'
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Authentication

membership

Request

No request body documented.

Responses and errors

Request IDs: X-Request-IDFull OpenAPI operation
POST/api/organizations/{id}/roles

Create a custom role

This operation is part of the public Lucion Identity contract.

Safe request
curl -X POST 'https://identity.lucionglobal.com/api/organizations/YOUR_ID/roles'
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'
  -H 'Content-Type: application/json'
  -H 'Idempotency-Key: YOUR_IDEMPOTENCY_KEY'
  --data '{}'

Authentication

admin + step-up

Request

No request body documented.

Responses and errors

Request IDs: X-Request-IDFull OpenAPI operation
PATCH/api/organizations/{id}/roles/{role_id}

Update a custom role

This operation is part of the public Lucion Identity contract.

Safe request
curl -X PATCH 'https://identity.lucionglobal.com/api/organizations/YOUR_ID/roles/{role_id}'
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'
  -H 'Content-Type: application/json'
  -H 'Idempotency-Key: YOUR_IDEMPOTENCY_KEY'
  --data '{}'

Authentication

admin + step-up

Request

No request body documented.

Responses and errors

Request IDs: X-Request-IDFull OpenAPI operation
DELETE/api/organizations/{id}/roles/{role_id}

Delete an unused custom role

This operation is part of the public Lucion Identity contract.

Safe request
curl -X DELETE 'https://identity.lucionglobal.com/api/organizations/YOUR_ID/roles/{role_id}'
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Authentication

admin + step-up

Request

No request body documented.

Responses and errors

Request IDs: X-Request-IDFull OpenAPI operation

A role is an organization-local set of permissions. Roles do not replace OAuth scopes, and an API scope does not grant membership in an organization.