Skip to content
API Reference/
/
catalog_roles_create

ibl-data-manager (4.84.1-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

analytics

Operations

career

Operations

catalog

Operations

catalog_roles_retrieve

Request

Retrieve roles matching query parameters. Supports filtering by name, id, and slug.

Security
PlatformApiKeyAuthentication
Query
idinteger

Role ID

namestringnon-empty

Role name

name__iexactstringnon-empty

Exact match for role name (case insensitive)

pageinteger

Page number for pagination

page_sizeinteger

Number of items per page

platform_keystringnon-empty

Platform key

slugstringnon-empty

Role slug

sortstringnon-empty

Field to sort results by

Default "id"
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/roles/?id=0&name=string&name__iexact=string&page=0&page_size=0&platform_key=string&slug=string&sort=id' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idintegerread-onlyrequired
namestring or nullread-onlyrequired

The display name of the role.

slugstring or nullread-onlyrequired

An additional unique slug field.

platform_keystring
skillsArray of objects(Skill)required
skills[].​skill_idintegerrequired
skills[].​namestring or null
skills[].​slugstring or null
skills[].​platformstring or null
dataany or nullread-onlyrequired

Metadata

Response
application/json
{
  "id": 0,
  "name": "string",
  "slug": "string",
  "platform_key": "string",
  "skills": [
    { … }
  ],
  "data": null
}

catalog_roles_create

Request

Add a new role or update an existing role based on provided data.

Security
PlatformApiKeyAuthentication
Query
idinteger

Role ID

namestringnon-empty

Role name

name__iexactstringnon-empty

Exact match for role name (case insensitive)

pageinteger

Page number for pagination

page_sizeinteger

Number of items per page

platform_keystringnon-empty

Platform key

slugstringnon-empty

Role slug

sortstringnon-empty

Field to sort results by

Default "id"
Body
required
idinteger

Role ID (for updates)

namestringrequired

Role name

slugstring

Role slug

platform_keystring

Platform key

dataany

Additional role data

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/roles/?id=0&name=string&name__iexact=string&page=0&page_size=0&platform_key=string&slug=string&sort=id' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "name": "string",
    "slug": "string",
    "platform_key": "string",
    "data": null
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
namestring or nullread-onlyrequired

The display name of the role.

slugstring or nullread-onlyrequired

An additional unique slug field.

platform_keystring
skillsArray of objects(Skill)required
skills[].​skill_idintegerrequired
skills[].​namestring or null
skills[].​slugstring or null
skills[].​platformstring or null
dataany or nullread-onlyrequired

Metadata

Response
application/json
{
  "id": 0,
  "name": "string",
  "slug": "string",
  "platform_key": "string",
  "skills": [
    { … }
  ],
  "data": null
}

catalog_roles_desired_retrieve

Request

Retrieve desired roles for a user.

Security
PlatformApiKeyAuthentication
Query
user_idinteger

User ID

usernamestringnon-empty

Username

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/roles/desired/?user_id=0&username=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
user_idinteger
usernamestring
rolesArray of objects(Role)required
roles[].​idintegerread-onlyrequired
roles[].​namestring or nullread-onlyrequired

The display name of the role.

roles[].​slugstring or nullread-onlyrequired

An additional unique slug field.

roles[].​platform_keystring
roles[].​skillsArray of objects(Skill)required
roles[].​skills[].​skill_idintegerrequired
roles[].​skills[].​namestring or null
roles[].​skills[].​slugstring or null
roles[].​skills[].​platformstring or null
roles[].​dataany or nullread-onlyrequired

Metadata

dataany or nullread-onlyrequired
Response
application/json
{
  "user_id": 0,
  "username": "string",
  "roles": [
    { … }
  ],
  "data": null
}

core

Operations

credentials

Operations

custom-domains

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com