Skip to content
API Reference
/
catalog
/
catalog_enrollment_programs_self_create

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_enrollment_programs_search_retrieve

Request

Search program enrollments based on user or program identifiers. Returns paginated enrollment results.

Security
PlatformApiKeyAuthentication
Query
include_default_platformboolean

Include enrollments from default platform

orgstringnon-empty

Filter enrollments by organization

pageinteger

Page number for pagination

page_sizeinteger

Number of items per page

platform_keystringnon-empty

Filter enrollments by platform key

program_idstringnon-empty

Filter enrollments by program ID

program_typestringnon-empty

Filter by program type (standard, platform, custom)

slugstringnon-empty

Filter enrollments by program slug

sortstringnon-empty

Field to sort results by

Default "-id"
user_idstringnon-empty

Filter enrollments by user ID

usernamestringnon-empty

Filter enrollments by username

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/enrollment/programs/search/?include_default_platform=true&org=string&page=0&page_size=0&platform_key=string&program_id=string&program_type=string&slug=string&sort=-id&user_id=string&username=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
resultsArray of objects(ProgramEnrollmentPlus)required

List of program enrollments

results[].​user_idinteger
results[].​usernamestring
results[].​program_idstring
results[].​program_keystring
results[].​platform_keystring
results[].​orgstring
results[].​namestring
results[].​slugstring
results[].​createdstring or null(date-time)

Date when enrollment began/activated

results[].​startedstring or null(date-time)

Date when enrollment started

results[].​endedstring or null(date-time)read-onlyrequired

Date when enrollment ended/deactivated

results[].​expiredstring or null(date-time)

Date when enrollment expires (null, if not expiring)

results[].​activeboolean

Whether the enrollment is active

results[].​metadataany or null
countintegerrequired

Total number of reviews

next_pageinteger or nullrequired

Next page number

previous_pageinteger or nullrequired

Previous page number

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

catalog_enrollment_programs_self_create

Request

Log user enrollment with a program.

Security
PlatformApiKeyAuthentication
Query
activeboolean

Whether the enrollment should be active

Default true
expiredstring(date-time)

Date when enrollment expires

ignore_expirationboolean

Whether to ignore expiration during unenrollment

Default false
orgstringnon-empty

Organization for the program

platform_keystringnon-empty

Platform key for the program

program_idstringnon-empty

Program ID for self-enrollment

program_keystringnon-empty

Program key for self-enrollment

slugstringnon-empty

Program slug for self-enrollment

startedstring(date-time)

Date when enrollment started

user_idstringnon-empty

User ID for self-enrollment

usernamestringnon-empty

Username for self-enrollment

Body
user_idinteger
usernamestring
program_idstring
program_keystring
platform_keystring
orgstring
namestring
slugstring
createdstring or null(date-time)

Date when enrollment began/activated

startedstring or null(date-time)

Date when enrollment started

expiredstring or null(date-time)

Date when enrollment expires (null, if not expiring)

activeboolean

Whether the enrollment is active

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/enrollment/programs/self/?active=true&expired=2019-08-24T14%3A15%3A22Z&ignore_expiration=false&org=string&platform_key=string&program_id=string&program_key=string&slug=string&started=2019-08-24T14%3A15%3A22Z&user_id=string&username=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_id": 0,
    "username": "string",
    "program_id": "string",
    "program_key": "string",
    "platform_key": "string",
    "org": "string",
    "name": "string",
    "slug": "string",
    "created": "2019-08-24T14:15:22Z",
    "started": "2019-08-24T14:15:22Z",
    "expired": "2019-08-24T14:15:22Z",
    "active": true
  }'

Responses

Bodyapplication/json
user_idinteger
usernamestring
program_idstring
program_keystring
platform_keystring
orgstring
namestring
slugstring
createdstring or null(date-time)

Date when enrollment began/activated

startedstring or null(date-time)

Date when enrollment started

endedstring or null(date-time)read-onlyrequired

Date when enrollment ended/deactivated

expiredstring or null(date-time)

Date when enrollment expires (null, if not expiring)

activeboolean

Whether the enrollment is active

Response
application/json
{
  "user_id": 0,
  "username": "string",
  "program_id": "string",
  "program_key": "string",
  "platform_key": "string",
  "org": "string",
  "name": "string",
  "slug": "string",
  "created": "2019-08-24T14:15:22Z",
  "started": "2019-08-24T14:15:22Z",
  "ended": "2019-08-24T14:15:22Z",
  "expired": "2019-08-24T14:15:22Z",
  "active": true
}

catalog_enrollment_programs_self_destroy

Request

Unenroll from a program. Deactivates enrollment.

Security
PlatformApiKeyAuthentication
Query
activeboolean

Whether the enrollment should be active

Default true
expiredstring(date-time)

Date when enrollment expires

ignore_expirationboolean

Whether to ignore expiration during unenrollment

Default false
orgstringnon-empty

Organization for the program

platform_keystringnon-empty

Platform key for the program

program_idstringnon-empty

Program ID for self-enrollment

program_keystringnon-empty

Program key for self-enrollment

slugstringnon-empty

Program slug for self-enrollment

startedstring(date-time)

Date when enrollment started

user_idstringnon-empty

User ID for self-enrollment

usernamestringnon-empty

Username for self-enrollment

curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/enrollment/programs/self/?active=true&expired=2019-08-24T14%3A15%3A22Z&ignore_expiration=false&org=string&platform_key=string&program_id=string&program_key=string&slug=string&started=2019-08-24T14%3A15%3A22Z&user_id=string&username=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

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