Skip to content
API Reference
/
catalog
/
catalog_licenses_user_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_user_retrieve

Request

Retrieve a paginated list of user licenses

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)

pageinteger

Page number for pagination

page_sizeinteger

Number of results per page

platform_keystringnon-empty

The unique identifier for the platform

querystringnon-empty

Search license names (contains)

sortstringnon-empty

Field to sort results by

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/user/?active=true&external_id=string&key=string&name=string&page=0&page_size=0&platform_key=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(UserLicenseDetail)required

List of user 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

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

results[].​platform_keystringrequired

The platform key associated with the license

results[].​usage_countinteger

Number of assignments using this license

Default 0
results[].​assignmentsany

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_user_assignment_retrieve

Request

Retrieve a paginated list of user license assignments

Security
PlatformApiKeyAuthentication
Query
license_idintegerrequired

The ID of the user 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/user/assignment/?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(UserLicenseAssignmentDetail)required

List of user license assignments

results[].​idintegerrequired

The unique identifier for the assignment

results[].​user_idintegerrequired

The ID of the user assigned the license

results[].​usernamestringrequired

The username 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

results[].​fulfilledbooleanrequired

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 user license

results[].​license_namestringrequired

The name of the user license

results[].​platform_keystringrequired

The platform key associated with the license

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

catalog_licenses_user_assignment_create

Request

Create or update a user license assignment

Security
PlatformApiKeyAuthentication
Query
license_idintegerrequired

The ID of the user 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 user 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/user/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

fulfilledbooleanrequired

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 user license

license_namestringrequired

The name of the user license

platform_keystringrequired

The platform key 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",
  "platform_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