Skip to content
API Reference
/
catalog
/
catalog_licenses_program_assignment_group_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_assignment_destroy

Request

Unassign single user from license

Security
PlatformApiKeyAuthentication
Query
activeboolean

Filter by the active status of assignments

assignment_idintegerrequired

The ID of the assignment to delete

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

platform_orgstringnon-empty

The organization identifier for the platform (for permission validation)

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 DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/licenses/program/assignment/?active=true&assignment_id=0&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

Assignment successfully deleted

catalog_licenses_program_assignment_group_retrieve

Request

Retrieve a paginated list of program license group assignments

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"
curl -i -X GET \
  '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'

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(ProgramLicenseGroupAssignmentDetail)required

List of program license group assignments

results[].​idintegerrequired

The unique identifier for the assignment

results[].​group_idintegerrequired

The ID of the group assigned the license

results[].​group_namestringrequired

The name of the group assigned the license

results[].​activebooleanrequired

Whether the assignment is active and valid

results[].​fulfilledbooleanrequired

Whether the assignment has been processed/fulfilled

results[].​redirect_tostring or null(uri)required

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)required

When the assignment was created

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

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

results[].​program_namestringrequired

The name of the program associated with the license

results[].​user_countintegerrequired

Number of users in the group

results[].​assigned_countintegerrequired

Number of users in the group who have been assigned the license

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

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
}

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