Skip to content

/

/

Retrieve RBAC policy

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

API for iblai

Download OpenAPI description

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

career

Operations

catalog

Operations

core

Operations

Create RBAC policy

Request

Create a new RBAC policy that defines resource access for a role

Security

PlatformApiKeyAuthentication

Body

required

resourcesArray of stringsrequired

List of resource paths this policy grants access to (e.g., ['/platforms/1/mentors', '/platforms/1/mentors/settings'])

role_idintegerwrite-onlyrequired

ID of the role this policy applies to

platform_keystringwrite-onlyrequired

Platform key where this policy applies

users_to_addArray of integerswrite-only

List of user IDs to add to this Policy

users_to_removeArray of integerswrite-only

List of user IDs to remove from this Policy

groups_to_addArray of integerswrite-only

List of group IDs to add to this Policy

groups_to_removeArray of integerswrite-only

List of group IDs to remove from this Policy

curl -i -X POST \
  https://docs.ibl.ai/_mock/apis/ibl/api/core/rbac/policies/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "resources": [
      "string"
    ],
    "role_id": 0,
    "platform_key": "string",
    "users_to_add": [
      0
    ],
    "users_to_remove": [
      0
    ],
    "groups_to_add": [
      0
    ],
    "groups_to_remove": [
      0
    ]
  }'

Responses

Bodyapplication/json

idintegerread-onlyrequired

roleobjectread-onlyrequired

Serializer for roles.

role.idintegerread-onlyrequired

role.namestring<= 255 charactersrequired

role.actionsArray of stringsrequired

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

platformobjectread-onlyrequired

Serializer for platforms.

platform.idintegerread-onlyrequired

platform.keystring<= 200 charactersrequired

The platform key

platform.namestring or null<= 200 characters

The name of the platform

resourcesArray of stringsrequired

List of resource paths this policy grants access to (e.g., ['/platforms/1/mentors', '/platforms/1/mentors/settings'])

usersArray of objects(RbacUser)read-onlyrequired

users[].idintegerread-onlyrequired

edX user ID

users[].usernamestring or null<= 100 characters

edX username

groupsArray of objects(RbacPolicyGroup)read-onlyrequired

groups[].idintegerread-onlyrequired

groups[].namestring<= 255 characters

Optional name of the group

groups[].unique_idstring<= 255 charactersrequired

The unique identifier for the group

groups[].descriptionstring

Optional group description

Response

application/json

{
  "id": 0,
  "role": {
    "id": 0,
    "name": "string",
    "actions": [ … ]
  },
  "platform": {
    "id": 0,
    "key": "string",
    "name": "string"
  },
  "resources": [
    "string"
  ],
  "users": [
    { … }
  ],
  "groups": [
    { … }
  ]
}

Retrieve RBAC policy

Request

Retrieve details of a specific RBAC policy, including role, platform, resources, users, and groups.

Security

PlatformApiKeyAuthentication

Path

idintegerrequired

A unique integer value identifying this RBAC Policy.

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

Responses

Bodyapplication/json

idintegerread-onlyrequired

roleobjectread-onlyrequired

Serializer for roles.

role.idintegerread-onlyrequired

role.namestring<= 255 charactersrequired

role.actionsArray of stringsrequired

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

platformobjectread-onlyrequired

Serializer for platforms.

platform.idintegerread-onlyrequired

platform.keystring<= 200 charactersrequired

The platform key

platform.namestring or null<= 200 characters

The name of the platform

resourcesArray of stringsrequired

List of resource paths this policy grants access to (e.g., ['/platforms/1/mentors', '/platforms/1/mentors/settings'])

usersArray of objects(RbacUser)read-onlyrequired

users[].idintegerread-onlyrequired

edX user ID

users[].usernamestring or null<= 100 characters

edX username

groupsArray of objects(RbacPolicyGroup)read-onlyrequired

groups[].idintegerread-onlyrequired

groups[].namestring<= 255 characters

Optional name of the group

groups[].unique_idstring<= 255 charactersrequired

The unique identifier for the group

groups[].descriptionstring

Optional group description

Response

application/json

{
  "id": 0,
  "role": {
    "id": 0,
    "name": "string",
    "actions": [ … ]
  },
  "platform": {
    "id": 0,
    "key": "string",
    "name": "string"
  },
  "resources": [
    "string"
  ],
  "users": [
    { … }
  ],
  "groups": [
    { … }
  ]
}

Update RBAC policy

Request

Update an existing RBAC policy.

Security

PlatformApiKeyAuthentication

Path

idintegerrequired

A unique integer value identifying this RBAC Policy.

Body

required

resourcesArray of stringsrequired

List of resource paths this policy grants access to (e.g., ['/platforms/1/mentors', '/platforms/1/mentors/settings'])

role_idintegerwrite-onlyrequired

ID of the role this policy applies to

platform_keystringwrite-onlyrequired

Platform key where this policy applies

users_to_addArray of integerswrite-only

List of user IDs to add to this Policy

users_to_removeArray of integerswrite-only

List of user IDs to remove from this Policy

groups_to_addArray of integerswrite-only

List of group IDs to add to this Policy

groups_to_removeArray of integerswrite-only

List of group IDs to remove from this Policy

curl -i -X PUT \
  'https://docs.ibl.ai/_mock/apis/ibl/api/core/rbac/policies/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "resources": [
      "string"
    ],
    "role_id": 0,
    "platform_key": "string",
    "users_to_add": [
      0
    ],
    "users_to_remove": [
      0
    ],
    "groups_to_add": [
      0
    ],
    "groups_to_remove": [
      0
    ]
  }'

Responses

Bodyapplication/json

idintegerread-onlyrequired

roleobjectread-onlyrequired

Serializer for roles.

role.idintegerread-onlyrequired

role.namestring<= 255 charactersrequired

role.actionsArray of stringsrequired

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

platformobjectread-onlyrequired

Serializer for platforms.

platform.idintegerread-onlyrequired

platform.keystring<= 200 charactersrequired

The platform key

platform.namestring or null<= 200 characters

The name of the platform

resourcesArray of stringsrequired

List of resource paths this policy grants access to (e.g., ['/platforms/1/mentors', '/platforms/1/mentors/settings'])

usersArray of objects(RbacUser)read-onlyrequired

users[].idintegerread-onlyrequired

edX user ID

users[].usernamestring or null<= 100 characters

edX username

groupsArray of objects(RbacPolicyGroup)read-onlyrequired

groups[].idintegerread-onlyrequired

groups[].namestring<= 255 characters

Optional name of the group

groups[].unique_idstring<= 255 charactersrequired

The unique identifier for the group

groups[].descriptionstring

Optional group description

Response

application/json

{
  "id": 0,
  "role": {
    "id": 0,
    "name": "string",
    "actions": [ … ]
  },
  "platform": {
    "id": 0,
    "key": "string",
    "name": "string"
  },
  "resources": [
    "string"
  ],
  "users": [
    { … }
  ],
  "groups": [
    { … }
  ]
}

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

search

Operations

skills

Operations