catalog_metadata_choices

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_user_update_create

Request

API View for updating existing user licenses.

This endpoint allows administrators to update the properties of an existing user license.

Methods: POST: Update an existing user license

Request Body: A JSON object containing:

license_id (int, optional): The ID of the license to update (required if external_id not provided)
external_id (str, optional): External identifier of the license to update (required if license_id not provided)
name (str, optional): Updated display name for the license
count (int, optional): Updated number of seats purchased
started (datetime, optional): Updated date when license should begin
expired (datetime, optional): Updated date when license should expire
active (bool, optional): Updated active status
metadata (dict, optional): Updated additional license metadata
enrollment_config (dict, optional): Updated enrollment configuration
source (str, optional): Updated source identifier
change_type (str, optional): Type of change being made (default: "update")

Returns: POST: A JSON response containing the updated license: { "id": 123, "created": "2023-06-15T14:30:00Z", "started": "2023-06-15T14:30:00Z", "expired": "2024-06-15T14:30:00Z", "name": "Updated User License 2023", "count": 150, "active": true, "metadata": {"updated": true}, "source": "updated-source", "external_id": "ext-123", "platform_key": "platform1" }

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 update licenses 404 Not Found: If the specified license doesn't exist 500 Internal Server Error: If an unexpected error occurs during license update

Access Control:

Requires IsDMAdmin permission
Available only to DM administrators

Notes:

Cannot update the platform associated with a license
A license history record is automatically created for each update

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

enrollment_configobject

Updated enrollment configuration

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/user/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
    },
    "enrollment_config": {
      "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

usage_countinteger

Number of assignments using this license

Default 0

assignmentsany

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",
  "usage_count": 0,
  "assignments": null
}