Skip to content

ibl-data-manager (3.59.0-ai-plus)

API for iblai

Download OpenAPI description
Languages
Servers
Mock server

https://docs.ibl.ai/_mock/apis/ibl/

https://base.manager.iblai.app/

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

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

catalog_licenses_user_assignment_destroy

Request

Remove a user license assignment

Security
PlatformApiKeyAuthentication
Query
assignment_idintegerrequired

The ID of the assignment to delete

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 DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/licenses/user/assignment/?assignment_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

Assignment successfully deleted

catalog_licenses_user_assignment_check_retrieve

Request

Check if a user has an active user license assignment

Query
emailstring(email)non-emptyrequired

The email address to check for active license assignments

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/licenses/user/assignment/check/?email=user%40example.com'

Responses

Active license assignment exists for the email

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations