Skip to content
API Reference/
/
List RBAC roles

ibl-data-manager (4.84.1-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
Languages
Servers
Mock server
https://docs.ibl.ai/_mock/apis/ibl/
https://base.manager.iblai.app/

ai-account

Operations

ai-analytics

Operations

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

analytics

Operations

career

Operations

catalog

Operations

core

Operations

Delete RBAC policy

Request

Delete an RBAC policy.

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this RBAC Policy.

Query
platform_keystringnon-emptyrequired

platform key for authorization check

curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/core/rbac/policies/{id}/?platform_key=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Policy deleted successfully

List RBAC roles

Request

Retrieve a list of RBAC roles. Can be filtered by platform_key and name.

Security
PlatformApiKeyAuthentication
Query
namestringnon-empty

Filter roles by name (case-insensitive partial match)

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

platform_keystringnon-empty

Filter roles by platform key

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/core/rbac/roles/?name=string&page=0&page_size=0&platform_key=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired
Example: 123
nextstring or null(uri)
Example: "http://api.example.org/accounts/?page=4"
previousstring or null(uri)
Example: "http://api.example.org/accounts/?page=2"
resultsArray of objects(RbacRole)required
results[].​idintegerread-onlyrequired
results[].​namestring<= 255 charactersrequired
results[].​platformobjectread-onlyrequired
results[].​platform.​idintegerread-onlyrequired
results[].​platform.​keystring<= 200 charactersrequired

The platform key

results[].​platform.​namestring or null<= 200 characters

The name of the platform

results[].​actionsArray of strings

List of actions/permissions this role can perform (e.g., ['Ibl.Mentor/Settings/read', 'Ibl.Mentor/Settings/write'])

results[].​data_actionsArray of strings

List of data actions/permissions this role can perform for field-level access (e.g., ['Ibl.Mentor/Settings/name/read', 'Ibl.Mentor/Settings/email/write'])

results[].​is_internalbooleanread-onlyrequired

When True, this role is internal to the system and cannot be viewed or modified by tenants via API endpoints.

Response
application/json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    { … }
  ]
}

Create RBAC role

Request

Create a new RBAC role for a platform.

Security
PlatformApiKeyAuthentication
Body
required
namestring<= 255 charactersrequired
platform_keystringwrite-onlyrequired

Platform key where this role belongs

actionsArray of strings

List of actions/permissions this role can perform (e.g., ['Ibl.Mentor/Settings/read', 'Ibl.Mentor/Settings/write'])

data_actionsArray of strings

List of data actions/permissions this role can perform for field-level access (e.g., ['Ibl.Mentor/Settings/name/read', 'Ibl.Mentor/Settings/email/write'])

curl -i -X POST \
  https://docs.ibl.ai/_mock/apis/ibl/api/core/rbac/roles/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "platform_key": "string",
    "actions": [
      "string"
    ],
    "data_actions": [
      "string"
    ]
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
namestring<= 255 charactersrequired
platformobjectread-onlyrequired
platform.​idintegerread-onlyrequired
platform.​keystring<= 200 charactersrequired

The platform key

platform.​namestring or null<= 200 characters

The name of the platform

actionsArray of strings

List of actions/permissions this role can perform (e.g., ['Ibl.Mentor/Settings/read', 'Ibl.Mentor/Settings/write'])

data_actionsArray of strings

List of data actions/permissions this role can perform for field-level access (e.g., ['Ibl.Mentor/Settings/name/read', 'Ibl.Mentor/Settings/email/write'])

is_internalbooleanread-onlyrequired

When True, this role is internal to the system and cannot be viewed or modified by tenants via API endpoints.

Response
application/json
{
  "id": 0,
  "name": "string",
  "platform": {
    "id": 0,
    "key": "string",
    "name": "string"
  },
  "actions": [
    "string"
  ],
  "data_actions": [
    "string"
  ],
  "is_internal": true
}

credentials

Operations

custom-domains

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com