Skip to content
API Reference
/
catalog
/
catalog_licenses_program_assignment_retrieve

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_program_retrieve

Request

API View for managing program licenses.

This endpoint allows retrieving program licenses with filtering and pagination support.

Query Parameters: platform_key (str, optional): The unique identifier for the platform name (str, optional): Filter by license name (exact match) source (str, optional): Filter by license source active (bool, optional): Filter by active status program_id (str, optional): Filter by program ID query (str, optional): Search licenses by name (contains) page (int, optional): Page number for pagination page_size (int, optional): Number of items per page verbose (bool, optional): Include additional details in response sort (str, optional): Field to sort results by (default: '-id')

Methods: GET: Retrieve a paginated list of program licenses

Returns: GET: A paginated JSON response containing program licenses: { "count": 10, "next": "https://example.com/api/catalog/licenses/program/?page=2", "previous": null, "results": [ { "id": 123, "created": "2023-06-15T14:30:00Z", "started": "2023-06-15T14:30:00Z", "expired": null, "name": "Program License 2023", "count": 100, "active": true, "metadata": {}, "source": "source", "external_id": "ext-123", "platform_key": "platform1", "program_id": "program-v1:org+program+run", "assignments": { "total": 50, "active": 45, "pending": 5 } }, ... ] }

Error Responses: 400 Bad Request: If query parameters are invalid 401 Unauthorized: If the user is not authenticated 403 Forbidden: If the user does not have permission to access this resource 500 Internal Server Error: If an unexpected error occurs

Access Control:

  • Requires IsDMAdmin or IsPlatformAdminReadOnly permission
  • Available to platform administrators (read-only) and DM admins
Security
PlatformApiKeyAuthentication
Query
activeboolean

Filter by active status

external_idstringnon-empty

Filter by external identifier

keystringnon-empty

Alternative filter by platform key

namestringnon-empty

Filter by license name (exact match)

orgstringnon-empty

Alternative filter by platform organization

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

program_idstringnon-empty

Filter by program ID

querystringnon-empty

Search license names (contains)

sortstringnon-empty

Field to sort results by (e.g., '-id', 'created', '-created')

Default "-id"
sourcestringnon-empty

Filter by license source

verboseboolean

Include detailed assignment data in the response

Default false
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/licenses/program/?active=true&external_id=string&key=string&name=string&org=string&page=0&page_size=0&platform_key=string&platform_org=string&program_id=string&query=string&sort=-id&source=string&verbose=false' \
  -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(ProgramLicenseDetail)required

List of program licenses

results[].​idintegerrequired

The unique identifier for the license

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

When the license was created

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

When the license becomes active

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

When the license expires (null if no expiration)

results[].​namestringrequired

The display name of the license

results[].​countintegerrequired

The number of seats purchased

results[].​activebooleanrequired

Whether the license is active

results[].​metadataobjectrequired

Additional license metadata

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

The source identifier for the license

results[].​external_idstring or nullrequired

External identifier for the license (null if none)

results[].​platform_keystringrequired

The platform key associated with the license

results[].​program_idstring

The program ID associated with the license

results[].​program_keystring

The program key associated with the license

results[].​program_namestring

The name of the program associated with the license

results[].​usage_countintegerrequired

Number of assignments using this license

results[].​assignmentsobject

Assignment counts by status (only included in verbose mode)

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

catalog_licenses_program_assignment_retrieve

Request

Retrieve a paginated list of program license assignments

Security
PlatformApiKeyAuthentication
Query
activeboolean

Filter by the active status of assignments

emailstring(email)non-empty

Filter assignments for a specific email

fulfilledboolean

Filter by the fulfilled status of assignments

license_idintegerrequired

The ID of the program 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 (e.g., 'id', '-id', 'created', '-created')

Default "id"
user_idinteger

Filter assignments for a specific user ID

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/licenses/program/assignment/?active=true&email=user%40example.com&fulfilled=true&license_id=0&page=0&page_size=0&platform_key=string&platform_org=string&sort=id&user_id=0' \
  -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(ProgramLicenseAssignmentDetail)required

List of program license assignments

results[].​idintegerrequired

The unique identifier for the assignment

results[].​user_idinteger or nullrequired

The ID of the user assigned the license

results[].​usernamestring or nullrequired

The username of the user assigned the license

results[].​namestring or nullrequired

The full name of the user assigned the license

results[].​emailstring or null(email)required

The email address of the user assigned the license

results[].​activebooleanrequired

Whether the assignment is active and valid

results[].​fulfilledbooleanrequired

Whether the assignment has been processed/fulfilled

results[].​directboolean

Whether the assignment was directly assigned to the user (vs. via a group)

results[].​redirect_tostring(uri)

URL to redirect to after fulfillment

results[].​metadataobject or nullrequired

Additional metadata for the assignment

results[].​metadata.​property name*anyadditional property
results[].​createdstring(date-time)

When the assignment was created

results[].​modifiedstring(date-time)

When the assignment was last modified

results[].​license_idintegerrequired

The ID of the program license

results[].​license_namestringrequired

The name of the program license

results[].​program_keystringrequired

The program key associated with the license

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

catalog_licenses_program_assignment_create

Request

Create or update a program license assignment

Security
PlatformApiKeyAuthentication
Query
activeboolean

Filter by the active status of assignments

emailstring(email)non-empty

Filter assignments for a specific email

fulfilledboolean

Filter by the fulfilled status of assignments

license_idintegerrequired

The ID of the program 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 (e.g., 'id', '-id', 'created', '-created')

Default "id"
user_idinteger

Filter assignments for a specific user ID

Body
required
license_idintegerrequired

The ID of the program license to assign

user_idinteger

The user ID to assign the license to (required if email not provided)

usernamestring

The username to assign the license to (alternative to user_id)

emailstring(email)

The email to assign the license to (required if user_id not provided)

platform_keystring

The unique identifier for the platform (for permission validation)

platform_orgstring

The organization identifier for the platform (for permission validation)

activeboolean

Whether the assignment should be active

Default true
fulfilledboolean

Whether the assignment should be marked as fulfilled

Default false
directboolean

Whether the assignment is being directly assigned to the user

Default true
redirect_tostring or null

URL to redirect to after fulfillment

metadataobject

Additional metadata for the assignment

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/licenses/program/assignment/?active=true&email=user%40example.com&fulfilled=true&license_id=0&page=0&page_size=0&platform_key=string&platform_org=string&sort=id&user_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "license_id": 0,
    "user_id": 0,
    "username": "string",
    "email": "user@example.com",
    "platform_key": "string",
    "platform_org": "string",
    "active": true,
    "fulfilled": false,
    "direct": true,
    "redirect_to": "string",
    "metadata": {
      "property1": null,
      "property2": null
    }
  }'

Responses

Bodyapplication/json
idintegerrequired

The unique identifier for the assignment

user_idinteger or nullrequired

The ID of the user assigned the license

usernamestring or nullrequired

The username of the user assigned the license

namestring or nullrequired

The full name 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 and valid

fulfilledbooleanrequired

Whether the assignment has been processed/fulfilled

directboolean

Whether the assignment was directly assigned to the user (vs. via a group)

redirect_tostring(uri)

URL to redirect to after fulfillment

metadataobject or nullrequired

Additional metadata for the assignment

metadata.​property name*anyadditional property
createdstring(date-time)

When the assignment was created

modifiedstring(date-time)

When the assignment was last modified

license_idintegerrequired

The ID of the program license

license_namestringrequired

The name of the program license

program_keystringrequired

The program key associated with the license

Response
application/json
{
  "id": 0,
  "user_id": 0,
  "username": "string",
  "name": "string",
  "email": "user@example.com",
  "active": true,
  "fulfilled": true,
  "direct": true,
  "redirect_to": "http://example.com",
  "metadata": {
    "property1": null,
    "property2": null
  },
  "created": "2019-08-24T14:15:22Z",
  "modified": "2019-08-24T14:15:22Z",
  "license_id": 0,
  "license_name": "string",
  "program_key": "string"
}

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