Skip to content
API Reference/
/
Get user group access sta...

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

Get student mentor creation permission status

Request

Check whether students are currently allowed to create mentors on a platform

Security
PlatformApiKeyAuthentication
Query
platform_keystring[ 1 .. 255 ] charactersrequired

The platform key to check

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/core/rbac/student-mentor-creation/status/?platform_key=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
allow_students_to_create_mentorsbooleanrequired

Whether students can create mentors on this platform

platform_keystringrequired

The platform key

messagestring

Success message (only in set permission response)

Response
application/json
{
  "allow_students_to_create_mentors": true,
  "platform_key": "string",
  "message": "string"
}

Get user group access status

Request

Retrieve current group access information for a specific user, including all groups the user has access to and whether they have mentor management permissions.

Security
PlatformApiKeyAuthentication
Query
platform_keystringrequired

Platform key where the groups exist

user_idintegerrequired

ID of the user to check group access for

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

Responses

Bodyapplication/json
policy_idintegerread-onlyrequired

Policy ID

policy_namestringread-onlyrequired

Policy name

groups_with_accessArray of objects(UserGroupAccessInfo)read-onlyrequired

Groups with access

groups_with_access[].​idintegerrequired

Group ID

groups_with_access[].​namestringrequired

Group name

groups_with_access[].​descriptionstringrequired

Group description

groups_with_access[].​permissionsArray of stringsrequired

List of permissions user has for this group (e.g., ['read', 'manageMentors'])

Response
application/json
{
  "policy_id": 0,
  "policy_name": "string",
  "groups_with_access": [
    { … }
  ]
}

Manage user access to groups

Request

Create or update user access to groups by adding/removing group access. Creates one policy per user with GROUP_MENTOR_MANAGER role for managing mentor access.

Security
PlatformApiKeyAuthentication
Body
required
platform_keystringwrite-onlyrequired

Platform key where the groups exist

user_idinteger[ 0 .. 2147483647 ]write-onlyrequired

ID of the user to manage group access for

groups_to_addArray of integerswrite-only

List of group IDs to grant access to

groups_to_removeArray of integerswrite-only

List of group IDs to revoke access from

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

Responses

Bodyapplication/json
policy_idintegerread-onlyrequired

Policy ID

policy_namestringread-onlyrequired

Policy name

groups_with_accessArray of objects(UserGroupAccessInfo)read-onlyrequired

Groups with access

groups_with_access[].​idintegerrequired

Group ID

groups_with_access[].​namestringrequired

Group name

groups_with_access[].​descriptionstringrequired

Group description

groups_with_access[].​permissionsArray of stringsrequired

List of permissions user has for this group (e.g., ['read', 'manageMentors'])

Response
application/json
{
  "policy_id": 0,
  "policy_name": "string",
  "groups_with_access": [
    { … }
  ]
}

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