Skip to content
API Reference/
/
Get mentor access status

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 group

Request

Delete an RBAC group and all associated group role assignments. Cannot delete internal system groups.

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this RBAC Group.

Query
platform_keystringnon-emptyrequired

platform key for authorization check

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

Responses

Group deleted successfully

Get mentor access status

Request

Retrieve current access information for a specific mentor, including all groups and users that have access with their respective roles.

Security
PlatformApiKeyAuthentication
Query
mentor_idintegerrequired

ID of the mentor to get access information for

platform_keystringrequired

Platform key where the mentor belongs

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

Responses

Bodyapplication/jsonArray [
idintegerread-onlyrequired
namestringread-onlyrequired

Policy name. If not supplied, defaults to a UUID4

rolestringrequired

Role for accessing this mentor (viewer or editor)

resourcesanyread-onlyrequired

List of resources this policy applies to

usersArray of objects(RbacUser)read-onlyrequired
users[].​idintegerread-onlyrequired

edX user ID

users[].​usernamestring or null<= 100 characters

edX username

users[].​emailstring or null(email)<= 254 characters

edX email

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,
    "name": "string",
    "role": "string",
    "resources": null,
    "users": [ … ],
    "groups": [ … ]
  }
]

Control which RbacGroups and/or Users have access to a mentor and with what Role

Request

Create or update RBAC policies to manage group and user access to specific mentors. Creates role-specific policies and handles adding/removing groups and users.

Security
PlatformApiKeyAuthentication
Body
required
platform_keystringwrite-onlyrequired

Platform key where the mentor belongs

mentor_idintegerwrite-onlyrequired

ID of the mentor to manage access for

rolestringrequired

Role for accessing this mentor (viewer or editor)

groups_to_addArray of integerswrite-only

List of group IDs to grant access to this mentor

groups_to_removeArray of integerswrite-only

List of group IDs to revoke access from this mentor

users_to_addArray of integerswrite-only

List of user IDs to grant access to this mentor

users_to_removeArray of integerswrite-only

List of user IDs to revoke access from this mentor

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

Responses

Bodyapplication/json
idintegerread-onlyrequired
namestringread-onlyrequired

Policy name. If not supplied, defaults to a UUID4

rolestringrequired

Role for accessing this mentor (viewer or editor)

resourcesanyread-onlyrequired

List of resources this policy applies to

usersArray of objects(RbacUser)read-onlyrequired
users[].​idintegerread-onlyrequired

edX user ID

users[].​usernamestring or null<= 100 characters

edX username

users[].​emailstring or null(email)<= 254 characters

edX email

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,
  "name": "string",
  "role": "string",
  "resources": null,
  "users": [
    { … }
  ],
  "groups": [
    { … }
  ]
}

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