Skip to content

/

/

Update RBAC group

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

Retrieve RBAC group

Request

Retrieve details of a specific RBAC group including assigned users.

Security

PlatformApiKeyAuthentication

Path

idintegerrequired

A unique integer value identifying this RBAC Group.

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

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": [
    { … }
  ]
}

Update RBAC group

Request

Update an existing RBAC group. Platform validation applies for user assignments.

Security

PlatformApiKeyAuthentication

Path

idintegerrequired

A unique integer value identifying this RBAC Group.

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 PUT \
  'https://docs.ibl.ai/_mock/apis/ibl/api/core/rbac/groups/{id}/' \
  -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": [
    { … }
  ]
}

Partially update RBAC group

Request

Partially update an existing RBAC group. Platform validation applies for user assignments.

Security

PlatformApiKeyAuthentication

Path

idintegerrequired

A unique integer value identifying this RBAC Group.

Body

unique_idstring<= 255 characters

The unique identifier for the group

platform_keystringwrite-only

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 PATCH \
  'https://docs.ibl.ai/_mock/apis/ibl/api/core/rbac/groups/{id}/' \
  -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

search

Operations

skills

Operations