Skip to content

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

API for iblai

Download OpenAPI description
Languages
Servers
Mock server
https://docs.ibl.ai/_mock/apis/ibl/
https://base.manager.iblai.app/
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Request

Initiates the account deletion process for the authenticated user or specified username.

Security
PlatformApiKeyAuthentication
Body
usernamestring
curl -i -X POST \
  https://docs.ibl.ai/_mock/apis/ibl/api/core/users/delete/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "username": "string"
  }'

Responses

Bodyapplication/json
messagestringrequired
Response
application/json
{ "message": "string" }

core_users_metadata_proxy_retrieve

Request

Get detailed user information.

Make permission check for platform admins here, then proxy request to edx.

Security
PlatformApiKeyAuthentication
Query
emailstring(email)non-empty
user_idinteger
usernamestringnon-empty
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/core/users/metadata/proxy/?email=user%40example.com&user_id=0&username=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

Request

Retrieve platforms associated with user_id

Params: user_id username email

Security
PlatformApiKeyAuthentication
Query
emailstring(email)non-empty
user_idinteger
usernamestringnon-empty
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/core/users/platforms/?email=user%40example.com&user_id=0&username=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
user_idintegerrequired
usernamestringrequired
emailstring(email)required
user_activebooleanrequired
keystringrequired
orgstringrequired
platform_namestringrequired
lms_urlstringrequired
cms_urlstringrequired
portal_urlstringrequired
is_adminboolean
is_staffboolean
added_onstring or null(date-time)
expired_onstring or null(date-time)
publicstringread-onlyrequired
activeboolean
]
Response
application/json
[ { "user_id": 0, "username": "string", "email": "user@example.com", "user_active": true, "key": "string", "org": "string", "platform_name": "string", "lms_url": "string", "cms_url": "string", "portal_url": "string", "is_admin": true, "is_staff": true, "added_on": "2019-08-24T14:15:22Z", "expired_on": "2019-08-24T14:15:22Z", "public": "string", "active": true } ]
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations