Skip to content
API Reference
/
catalog
/
catalog_licenses_program_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_program_assignment_group_create

Request

Create or update a program license group assignment

Security
PlatformApiKeyAuthentication
Query
activeboolean

Filter by the active status of group assignments

fulfilledboolean

Filter by the fulfilled status of group assignments

group_idinteger

Filter assignments for a specific user group ID

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"
Body
required
license_idintegerrequired

The ID of the program license to assign

group_idintegerrequired

The ID of the user group to assign the license to

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 group assignment should be active

Default true
fulfilledboolean

Whether the group assignment should be marked as fulfilled

Default false
redirect_tostring or null

URL to redirect to after fulfillment

metadataobject

Additional metadata for the group assignment

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/licenses/program/assignment/group/?active=true&fulfilled=true&group_id=0&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,
    "redirect_to": "string",
    "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 and valid

fulfilledbooleanrequired

Whether the assignment has been processed/fulfilled

redirect_tostring or null(uri)required

URL to redirect to after fulfillment

metadataobject or nullrequired

Additional metadata for the assignment

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

When the assignment was created

modifiedstring(date-time)required

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

program_namestringrequired

The name of the program associated with the license

user_countintegerrequired

Number of users in the group

assigned_countintegerrequired

Number of users in the group who have been assigned 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
  },
  "created": "2019-08-24T14:15:22Z",
  "modified": "2019-08-24T14:15:22Z",
  "license_id": 0,
  "license_name": "string",
  "program_key": "string",
  "program_name": "string",
  "user_count": 0,
  "assigned_count": 0
}

catalog_licenses_program_assignment_group_destroy

Request

Remove a program license group assignment

Security
PlatformApiKeyAuthentication
Query
activeboolean

Filter by the active status of group assignments

assignment_idintegerrequired

The ID of the assignment to delete

fulfilledboolean

Filter by the fulfilled status of group assignments

group_idinteger

Filter assignments for a specific user group ID

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 (for permission validation)

platform_orgstringnon-empty

The organization identifier for the platform (for permission validation)

remove_user_assignmentsboolean

Whether to also remove individual user assignments that were created by this group assignment

Default true
sortstringnon-empty

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

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

Responses

Assignment successfully deleted

catalog_licenses_program_create_create

Request

API View for creating program licenses.

This endpoint allows administrators to create new program licenses with various configurations.

Methods: POST: Create a new program license

Request Body: A JSON object containing:

  • platform_key (str, required): The platform to create a license for
  • program_id (str, required): The program ID to create a license for
  • name (str, optional): Display name for the license
  • count (int, optional): Number of seats purchased (default: 0)
  • started (datetime, optional): Date when license should begin
  • expired (datetime, optional): Date when license should expire
  • active (bool, optional): Whether the license is active (default: true)
  • metadata (dict, optional): Additional license metadata
  • enrollment_config (dict, optional): Additional enrollment configuration
  • source (str, optional): Source identifier
  • external_id (str, optional): External identifier (must be unique)

Returns: POST: A JSON response containing the created license: { "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" }

Error Responses: 400 Bad Request: If required parameters are missing or invalid 401 Unauthorized: If the user is not authenticated 403 Forbidden: If the user does not have permission to create licenses 500 Internal Server Error: If an unexpected error occurs during license creation

Access Control:

  • Requires IsDMAdmin permission
  • Available only to DM administrators
Security
PlatformApiKeyAuthentication
Body
required
platform_keystring

The unique identifier for the platform (required if platform_id not provided)

platform_orgstring

The organization identifier for the platform (required if platform_id not provided)

platform_idinteger

The ID of the platform (required if platform_key/org not provided)

program_keystringrequired

The unique identifier for the program to license

namestringrequired

Display name for the license

countintegerrequired

Number of seats purchased

startedstring(date-time)required

Date when license should begin

expiredstring or null(date-time)

Date when license should expire

external_idstring or null

External identifier for the license

activeboolean

Whether the license should be active

Default true
metadataobject

Additional license metadata

enrollment_configobject

Enrollment configuration

sourcestring

Source identifier

Default "api"
transaction_idstring

Transaction identifier for tracking

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

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 (null if no expiration)

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 (null if none)

platform_keystringrequired

The platform key associated with the license

program_idstring

The program ID associated with the license

program_keystring

The program key associated with the license

program_namestring

The name of the program associated with the license

usage_countintegerrequired

Number of assignments using this license

assignmentsobject

Assignment counts by status (only included in verbose mode)

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",
  "program_id": "string",
  "program_key": "string",
  "program_name": "string",
  "usage_count": 0,
  "assignments": {
    "property1": 0,
    "property2": 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