Skip to content
API Reference
/
core
/
List RBAC groups

ibl-data-manager (3.59.0-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

career

Operations

catalog

Operations

core

Operations

core_platform_users_retrieve

Request

Retrieve users associated with platform

Params: platform_key platform_org

query sort

is_admin: Return tenant admin users

Security
PlatformApiKeyAuthentication
Query
pageinteger
page_sizeinteger
platform_keystringnon-empty
platform_orgstringnon-empty
querystringnon-empty
sortstringnon-empty
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/core/platform/users/?page=0&page_size=0&platform_key=string&platform_org=string&query=string&sort=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired
next_pageintegerrequired
previous_pageintegerrequired
resultsArray of objectsrequired
results[].​property name*anyadditional property
Response
application/json
{
  "count": 35,
  "next_page": 4,
  "previous_page": 2,
  "results": [
    { … },
    { … },
    { … }
  ]
}

List RBAC groups

Request

Retrieve a list of RBAC groups. Can be filtered by platform_key.

Security
PlatformApiKeyAuthentication
Query
pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

platform_keystringnon-empty

Filter groups by platform key

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/core/rbac/groups/?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(RbacGroup)required
results[].​idintegerread-onlyrequired
results[].​unique_idstring<= 255 charactersrequired

The unique identifier for the group

results[].​platformobjectread-onlyrequired

Serializer for platforms.

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[].​namestring<= 255 characters

Optional name of the group

results[].​descriptionstring

Optional group description

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

edX user ID

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

edX username

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

Create RBAC group

Request

Create a new RBAC group for a platform. Users can be assigned during creation.

Security
PlatformApiKeyAuthentication
Body
required
unique_idstring<= 255 charactersrequired

The unique identifier for the group

platform_keystringwrite-onlyrequired

The platform key

namestring<= 255 characters

Optional name of the group

descriptionstring

Optional group description

users_to_addArray of integerswrite-only

List of user IDs to add to this group

users_to_removeArray of integerswrite-only

List of user IDs to remove from this group

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

Responses

Bodyapplication/json
idintegerread-onlyrequired
unique_idstring<= 255 charactersrequired

The unique identifier for the group

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

namestring<= 255 characters

Optional name of the group

descriptionstring

Optional group description

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

edX user ID

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

edX username

Response
application/json
{
  "id": 0,
  "unique_id": "string",
  "platform": {
    "id": 0,
    "key": "string",
    "name": "string"
  },
  "name": "string",
  "description": "string",
  "users": [
    { … }
  ]
}

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

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