Skip to content
API Reference/
/
core_platform_users_polic...

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

core

Operations

core_platform_users_retrieve

Request

Retrieve users associated with platform and optionally their policies when return_policies is set

Security
PlatformApiKeyAuthentication
Query
pageinteger
page_sizeinteger
platform_keystringnon-empty
platform_orgstringnon-empty
querystringnon-empty
return_policiesstringnon-empty
sortstringnon-empty
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/core/platform/users/?page=0&page_size=0&platform_key=string&platform_org=string&query=string&return_policies=string&sort=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired
next_pageintegerrequired
previous_pageintegerrequired
resultsArray of objectsrequired
results[].​property name*anyadditional property
allowed_policiesArray of strings
dataArray of objects
Response
application/json
{
  "count": 35,
  "next_page": 4,
  "previous_page": 2,
  "results": [
    { … },
    { … }
  ]
}

core_platform_users_policies_update

Request

Bulk update user policies on a platform. Requires Ibl.Core/UserPolicies/write permission.

Policy removals are processed before policy additions.

Body
requiredArray [
user_idintegerwrite-onlyrequired

ID of the user to update policies for

platform_keystringwrite-onlyrequired

Platform key where the user's policies should be updated

policies_to_addArray of stringswrite-only

List of policy names to add to the user

policies_to_removeArray of stringswrite-only

List of policy names to remove from the user

policies_to_setArray of stringswrite-only

List of policy names to set for the user (replaces all existing policies with these)

]
curl -i -X PUT \
  https://docs.ibl.ai/_mock/apis/ibl/api/core/platform/users/policies/ \
  -H 'Content-Type: application/json' \
  -d '[
    [
      {
        "user_id": 42,
        "platform_key": "ibltest",
        "policies_to_add": [
          "Analytics Viewer"
        ],
        "policies_to_remove": [
          "Mentor Chat"
        ]
      },
      {
        "user_id": 43,
        "platform_key": "ibltest",
        "policies_to_add": [
          "Mentor Viewer",
          "Mentor Editor"
        ]
      }
    ]
  ]'

Responses

Bodyapplication/json
user_idArray of stringsrequired

List of policies for the user

Response
application/json
{
  "42": [
    "Analytics Viewer",
    "Mentor Viewer"
  ],
  "43": [
    "Mentor Editor",
    "Mentor Viewer"
  ],
  "44": []
}

core_platforms_public_image_assets_list

Request

Shared functionality for platform public image asset views.

Security
PlatformApiKeyAuthentication
Path
platform_keystringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/core/platforms/{platform_key}/public-image-assets/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
idintegerread-onlyrequired
categorystring<= 200 charactersrequired

Category of the asset

urlstringread-onlyrequired
created_onstring(date-time)read-onlyrequired
last_updatedstring(date-time)read-onlyrequired
]
Response
application/json
[
  {
    "id": 0,
    "category": "string",
    "url": "string",
    "created_on": "2019-08-24T14:15:22Z",
    "last_updated": "2019-08-24T14:15:22Z"
  }
]

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