Skip to content
API Reference
/
catalog
/
catalog_licenses_platform_update_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_licenses_platform_create_create

Request

Create a new platform license

Security
PlatformApiKeyAuthentication
Body
required
platform_keystringrequired

The platform to create a license for

platform_orgstring

The organization identifier for the platform

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

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/platform/create/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "platform_key": "string",
    "platform_org": "string",
    "name": "string",
    "count": 0,
    "started": "2019-08-24T14:15:22Z",
    "expired": "2019-08-24T14:15:22Z",
    "active": true,
    "metadata": {
      "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

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"
}

catalog_licenses_platform_update_create

Request

Update an existing platform license

Security
PlatformApiKeyAuthentication
Body
license_idinteger

The ID of the license to update (required if external_id not provided)

external_idstring

External identifier of the license to update (required if license_id not provided)

platform_keystring

The platform key (not updatable)

platform_orgstring

The platform organization (not updatable)

namestring

Updated display name for the license

countinteger

Updated number of seats purchased

startedstring(date-time)

Updated date when license should begin

expiredstring or null(date-time)

Updated date when license should expire

activeboolean

Updated active status

metadataobject

Updated additional license metadata

sourcestring

Updated source identifier

transaction_idstring

Transaction identifier for tracking

change_typestring

Type of change being made

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

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

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"
}

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": [
    { … }
  ]
}

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