Skip to content
API Reference
/
catalog
/
catalog_licenses_course_assignment_group_destroy

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_licenses_course_assignment_group_create

Request

Create or update a course license group assignment

Security
PlatformApiKeyAuthentication
Query
license_idintegerrequired

The ID of the course license

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

sortstringnon-empty

Field to sort results by

Default "id"
Body
required
license_idintegerrequired

The ID of the course license

group_idintegerrequired

The group ID to assign the license to

platform_keystring

The unique identifier for the platform

platform_orgstring

The organization identifier for the platform

activeboolean

Whether the assignment is active

Default true
fulfilledboolean

Whether the assignment has been fulfilled

Default false
metadataobject

Additional metadata for the assignment

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/licenses/course/assignment/group/?license_id=0&page=0&page_size=0&platform_key=string&platform_org=string&sort=id' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "license_id": 0,
    "group_id": 0,
    "platform_key": "string",
    "platform_org": "string",
    "active": true,
    "fulfilled": false,
    "metadata": {
      "property1": null,
      "property2": null
    }
  }'

Responses

Bodyapplication/json
idintegerrequired

The unique identifier for the assignment

group_idintegerrequired

The ID of the group assigned the license

group_namestringrequired

The name of the group assigned the license

activebooleanrequired

Whether the assignment is active

fulfilledboolean

Whether the assignment has been fulfilled

redirect_tostring or null(uri)

URL to redirect to after fulfillment

metadataobjectrequired

Additional metadata for the assignment

metadata.​property name*anyadditional property
license_idintegerrequired

The ID of the course license

license_namestringrequired

The name of the course license

course_idstringrequired

The course ID associated with the license

Response
application/json
{
  "id": 0,
  "group_id": 0,
  "group_name": "string",
  "active": true,
  "fulfilled": true,
  "redirect_to": "http://example.com",
  "metadata": {
    "property1": null,
    "property2": null
  },
  "license_id": 0,
  "license_name": "string",
  "course_id": "string"
}

catalog_licenses_course_assignment_group_destroy

Request

Remove a course license group assignment

Security
PlatformApiKeyAuthentication
Query
assignment_idintegerrequired

The ID of the assignment to delete

license_idintegerrequired

The ID of the course license

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

sortstringnon-empty

Field to sort results by

Default "id"
curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/licenses/course/assignment/group/?assignment_id=0&license_id=0&page=0&page_size=0&platform_key=string&platform_org=string&sort=id' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Assignment successfully deleted

catalog_licenses_course_create_create

Request

Create a new course license

Security
PlatformApiKeyAuthentication
Body
required
platform_keystringrequired

The platform to create a license for

platform_orgstring

The organization identifier for the platform

course_idstringrequired

The course ID to create a license for

namestring

Display name for the license

countinteger

Number of seats purchased

Default 0
startedstring(date-time)

Date when license should begin

expiredstring or null(date-time)

Date when license should expire

activeboolean

Whether the license is active

Default true
metadataobject

Additional license metadata

enrollment_configobject

Additional enrollment configuration

sourcestring

Source identifier

external_idstring or null

External identifier (must be unique)

transaction_idstring

Transaction identifier for tracking

change_typestring

Type of change being made

Default "create"
curl -i -X POST \
  https://docs.ibl.ai/_mock/apis/ibl/api/catalog/licenses/course/create/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "platform_key": "string",
    "platform_org": "string",
    "course_id": "string",
    "name": "string",
    "count": 0,
    "started": "2019-08-24T14:15:22Z",
    "expired": "2019-08-24T14:15:22Z",
    "active": true,
    "metadata": {
      "property1": null,
      "property2": null
    },
    "enrollment_config": {
      "property1": null,
      "property2": null
    },
    "source": "string",
    "external_id": "string",
    "transaction_id": "string",
    "change_type": "create"
  }'

Responses

Bodyapplication/json
idintegerrequired

The unique identifier for the license

createdstring(date-time)required

When the license was created

startedstring(date-time)required

When the license becomes active

expiredstring or null(date-time)required

When the license expires

namestringrequired

The display name of the license

countintegerrequired

The number of seats purchased

activebooleanrequired

Whether the license is active

metadataobjectrequired

Additional license metadata

metadata.​property name*anyadditional property
sourcestringrequired

The source identifier for the license

external_idstring or nullrequired

External identifier for the license

platform_keystringrequired

The platform key associated with the license

course_idstringrequired

The course ID associated with the license

usage_countinteger

The number of seats purchased

Default 0
Response
application/json
{
  "id": 0,
  "created": "2019-08-24T14:15:22Z",
  "started": "2019-08-24T14:15:22Z",
  "expired": "2019-08-24T14:15:22Z",
  "name": "string",
  "count": 0,
  "active": true,
  "metadata": {
    "property1": null,
    "property2": null
  },
  "source": "string",
  "external_id": "string",
  "platform_key": "string",
  "course_id": "string",
  "usage_count": 0
}

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