Skip to content
API Reference
/
credentials
/
credentials_orgs_users_images_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

core

Operations

credentials

Operations

credentials_orgs_users_credentials_over_time_retrieve

Request

Get all credentials of a given tenant

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
department_idinteger

When department_mode=1 is passed, it allows to filter data for only user content groups for the specified department

end_datestringnon-empty

end date. ISO 8601

formatstringnon-empty

Format

  • json - json
Default "json"
Value"json"
include_main_platformboolean

Include main platform data

Default true
start_datestringnon-empty

start date. ISO 8601

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/credentials-over-time/?department_id=0&end_date=string&format=json&include_main_platform=true&start_date=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dataobjectrequired
data.​property name*anyadditional property
Response
application/json
{
  "data": {
    "property1": null,
    "property2": null
  }
}

credentials_orgs_users_images_retrieve

Request

API View for managing uploaded images for credentials.

This endpoint allows uploading new images and retrieving existing images for use with credentials (icons, backgrounds, thumbnails, etc.).

Path Parameters: org (str): The organization/tenant identifier user_id (str): The user ID making the request

Query Parameters: query (str, required for GET): Search term to filter images by name

Methods: GET: Retrieve images matching a search query POST: Upload a new image

POST Request Body: Multipart form data containing:

  • image (file, required): The image file to upload
  • name (str, optional): A descriptive name for the image

Returns: GET: A JSON array of image objects: [ { "id": 123, "name": "Logo", "image": "https://example.com/media/uploaded_images/logo.png" }, { "id": 124, "name": "Background", "image": "https://example.com/media/uploaded_images/background.jpg" }, ... ]

POST: A JSON object containing the uploaded image details: { "id": 125, "name": "Certificate Icon", "image": "https://example.com/media/uploaded_images/certificate-icon.png" }

Error Responses: 400 Bad Request: If the request data is invalid or missing required parameters 401 Unauthorized: If the user is not authenticated 403 Forbidden: If the user does not have permission to access this resource 500 Internal Server Error: If an unexpected error occurs

Access Control:

  • Requires IsAdminUserOrStudentDRFMixin
  • Only authenticated users with appropriate permissions can upload and retrieve images
Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/images/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idintegerread-onlyrequired
namestring or null<= 254 characters
imagestringread-onlyrequired
Response
application/json
{
  "id": 0,
  "name": "string",
  "image": "string"
}

credentials_orgs_users_images_create

Request

API View for managing uploaded images for credentials.

This endpoint allows uploading new images and retrieving existing images for use with credentials (icons, backgrounds, thumbnails, etc.).

Path Parameters: org (str): The organization/tenant identifier user_id (str): The user ID making the request

Query Parameters: query (str, required for GET): Search term to filter images by name

Methods: GET: Retrieve images matching a search query POST: Upload a new image

POST Request Body: Multipart form data containing:

  • image (file, required): The image file to upload
  • name (str, optional): A descriptive name for the image

Returns: GET: A JSON array of image objects: [ { "id": 123, "name": "Logo", "image": "https://example.com/media/uploaded_images/logo.png" }, { "id": 124, "name": "Background", "image": "https://example.com/media/uploaded_images/background.jpg" }, ... ]

POST: A JSON object containing the uploaded image details: { "id": 125, "name": "Certificate Icon", "image": "https://example.com/media/uploaded_images/certificate-icon.png" }

Error Responses: 400 Bad Request: If the request data is invalid or missing required parameters 401 Unauthorized: If the user is not authenticated 403 Forbidden: If the user does not have permission to access this resource 500 Internal Server Error: If an unexpected error occurs

Access Control:

  • Requires IsAdminUserOrStudentDRFMixin
  • Only authenticated users with appropriate permissions can upload and retrieve images
Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Body
namestring or null<= 254 characters
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/images/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string"
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
namestring or null<= 254 characters
imagestringread-onlyrequired
Response
application/json
{
  "id": 0,
  "name": "string",
  "image": "string"
}

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

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