Skip to content
API Reference
/
catalog
/
catalog_licenses_course_assignment_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_create

Request

Create or update a course license 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

user_idinteger

The user ID to assign the license to

emailstring(email)

The email 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/?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,
    "user_id": 0,
    "email": "user@example.com",
    "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

user_idintegerrequired

The ID of the user assigned the license

usernamestringrequired

The username of the user assigned the license

emailstring or null(email)required

The email address of the user 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,
  "user_id": 0,
  "username": "string",
  "email": "user@example.com",
  "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_destroy

Request

Remove a course license 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/?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_assignment_group_retrieve

Request

Retrieve a paginated list of course license group assignments

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"
curl -i -X GET \
  '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'

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(CourseLicenseGroupAssignmentDetail)required

List of course license group assignments

results[].​idintegerrequired

The unique identifier for the assignment

results[].​group_idintegerrequired

The ID of the group assigned the license

results[].​group_namestringrequired

The name of the group assigned the license

results[].​activebooleanrequired

Whether the assignment is active

results[].​fulfilledboolean

Whether the assignment has been fulfilled

results[].​redirect_tostring or null(uri)

URL to redirect to after fulfillment

results[].​metadataobjectrequired

Additional metadata for the assignment

results[].​metadata.​property name*anyadditional property
results[].​license_idintegerrequired

The ID of the course license

results[].​license_namestringrequired

The name of the course license

results[].​course_idstringrequired

The course ID associated with the license

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

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