Skip to content
API Reference
/
catalog

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

catalog_access_requests_course_manage_retrieve

Request

Retrieve a paginated list of access requests

Security
PlatformApiKeyAuthentication
Query
pageinteger

Page number for pagination

page_sizeinteger

Number of results per page

platform_keystringnon-empty

The unique identifier for the platform

platform_orgstringnon-empty

The organization identifier for the platform

reviewedboolean

Filter by reviewed status

sortstringnon-empty

Field to sort results by

Default "-id"
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/access_requests/course/manage/?page=0&page_size=0&platform_key=string&platform_org=string&reviewed=true&sort=-id' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired

Total number of results

next_pagestring or null(uri)required

URL for next page of results

previous_pagestring or null(uri)required

URL for previous page of results

resultsArray of objects(CourseAccessRequestDetail)required

List of access requests

results[].​idintegerrequired

The unique identifier for the access request

results[].​user_idintegerrequired

The ID of the user who made the request

results[].​usernamestringrequired

The username of the user who made the request

results[].​namestringrequired

The full name of the user who made the request

results[].​approvedboolean or nullrequired

Whether the request has been approved (null if not reviewed)

results[].​reviewedbooleanrequired

Whether the request has been reviewed

results[].​createdstring(date-time)required

When the request was created

results[].​modifiedstring(date-time)required

When the request was last modified

results[].​metadataobject

Additional metadata for the request

results[].​platform_keystringrequired

The platform key associated with the request

results[].​course_idstringrequired

The course ID associated with the request

Response
application/json
{
  "count": 0,
  "next_page": "http://example.com",
  "previous_page": "http://example.com",
  "results": [
    { … }
  ]
}

catalog_access_requests_course_manage_create

Request

Update an existing access request (approve/reject)

Security
PlatformApiKeyAuthentication
Query
pageinteger

Page number for pagination

page_sizeinteger

Number of results per page

platform_keystringnon-empty

The unique identifier for the platform

platform_orgstringnon-empty

The organization identifier for the platform

reviewedboolean

Filter by reviewed status

sortstringnon-empty

Field to sort results by

Default "-id"
Body
required
request_idintegerrequired

The ID of the access request to update

platform_keystring

The unique identifier for the platform

platform_orgstring

The organization identifier for the platform

approvedboolean

Whether to approve the request

activeboolean

Whether the request should remain active

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/access_requests/course/manage/?page=0&page_size=0&platform_key=string&platform_org=string&reviewed=true&sort=-id' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "request_id": 0,
    "platform_key": "string",
    "platform_org": "string",
    "approved": true,
    "active": true
  }'

Responses

Bodyapplication/json
idintegerrequired

The unique identifier for the access request

user_idintegerrequired

The ID of the user who made the request

usernamestringrequired

The username of the user who made the request

namestringrequired

The full name of the user who made the request

approvedboolean or nullrequired

Whether the request has been approved (null if not reviewed)

reviewedbooleanrequired

Whether the request has been reviewed

createdstring(date-time)required

When the request was created

modifiedstring(date-time)required

When the request was last modified

metadataobject

Additional metadata for the request

platform_keystringrequired

The platform key associated with the request

course_idstringrequired

The course ID associated with the request

Response
application/json
{
  "id": 0,
  "user_id": 0,
  "username": "string",
  "name": "string",
  "approved": true,
  "reviewed": true,
  "created": "2019-08-24T14:15:22Z",
  "modified": "2019-08-24T14:15:22Z",
  "metadata": {
    "property1": null,
    "property2": null
  },
  "platform_key": "string",
  "course_id": "string"
}

catalog_access_requests_course_request_retrieve

Request

Check if the user has an active access request for a course

Security
PlatformApiKeyAuthentication
Query
course_idstringnon-emptyrequired

The unique identifier for the course

platform_keystringnon-empty

The unique identifier for the platform

platform_orgstringnon-empty

The organization identifier for the platform

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/access_requests/course/request/?course_id=string&platform_key=string&platform_org=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
activebooleanrequired

Whether the access request is active

approvedboolean or nullrequired

Whether the access request has been approved (null if not reviewed)

existsbooleanrequired

Whether an access request exists for this user and course

Response
application/json
{
  "active": true,
  "approved": true,
  "exists": true
}

core

Operations

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