ibl-data-manager (3.59.0-ai-plus)
API for iblai
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
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/images/
https://base.manager.iblai.app/api/credentials/orgs/{org}/users/{user_id}/images/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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"
}'
{ "id": 0, "name": "string", "image": "string" }
Request
API View for managing credential issuers.
This endpoint allows creating and retrieving issuers for a specific organization/tenant, with support for filtering and pagination.
Path Parameters: org (str): The organization/tenant identifier user_id (str): The user ID making the request
Query Parameters: q (str, optional): Search term to filter issuers by name limit (int, optional): Number of results per page (default: 50) offset (int, optional): Starting position for pagination
Methods: GET: Retrieve issuers with filtering and pagination POST: Create a new issuer
POST Request Body: A JSON object containing issuer details:
- name (str): Issuer name
- iconImage (str, optional): URL to issuer icon
- email (str, optional): Contact email for the issuer
- url (str, optional): Website URL for the issuer
- allowed_template_tags (array, optional): List of allowed template tags
Returns: GET: A JSON response containing: { "status": {"success": true, "description": "Ok"}, "result": { "next": "URL to next page", "previous": "URL to previous page", "count": 10, "data": [ {issuer object}, {issuer object}, ... ], "num_pages": 1, "page_number": 1, "max_page_size": 1000 } }
POST: A JSON response containing: { "status": {"success": true, "description": "Created"}, "result": {issuer object} }
Error Responses: 400 Bad Request: If the request data is invalid 401 Unauthorized: If the user is not authenticated 403 Forbidden: If the user does not have permission to access this resource 404 Not Found: If the platform doesn't exist 500 Internal Server Error: If an unexpected error occurs
Access Control:
- Requires IsAdminUserOrStudentDRFMixin
- Only authenticated users with appropriate permissions can manage issuers
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/issuers/
https://base.manager.iblai.app/api/credentials/orgs/{org}/users/{user_id}/issuers/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/issuers/?q=string' \
-H 'Authorization: YOUR_API_KEY_HERE'
{ "name": "string", "org": "string", "entityId": "string", "signatories": { "property1": "string", "property2": "string" }, "url": "string", "iconImage": "string", "allowed_template_tags": null }
Request
API View for managing credential issuers.
This endpoint allows creating and retrieving issuers for a specific organization/tenant, with support for filtering and pagination.
Path Parameters: org (str): The organization/tenant identifier user_id (str): The user ID making the request
Query Parameters: q (str, optional): Search term to filter issuers by name limit (int, optional): Number of results per page (default: 50) offset (int, optional): Starting position for pagination
Methods: GET: Retrieve issuers with filtering and pagination POST: Create a new issuer
POST Request Body: A JSON object containing issuer details:
- name (str): Issuer name
- iconImage (str, optional): URL to issuer icon
- email (str, optional): Contact email for the issuer
- url (str, optional): Website URL for the issuer
- allowed_template_tags (array, optional): List of allowed template tags
Returns: GET: A JSON response containing: { "status": {"success": true, "description": "Ok"}, "result": { "next": "URL to next page", "previous": "URL to previous page", "count": 10, "data": [ {issuer object}, {issuer object}, ... ], "num_pages": 1, "page_number": 1, "max_page_size": 1000 } }
POST: A JSON response containing: { "status": {"success": true, "description": "Created"}, "result": {issuer object} }
Error Responses: 400 Bad Request: If the request data is invalid 401 Unauthorized: If the user is not authenticated 403 Forbidden: If the user does not have permission to access this resource 404 Not Found: If the platform doesn't exist 500 Internal Server Error: If an unexpected error occurs
Access Control:
- Requires IsAdminUserOrStudentDRFMixin
- Only authenticated users with appropriate permissions can manage issuers
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/issuers/
https://base.manager.iblai.app/api/credentials/orgs/{org}/users/{user_id}/issuers/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/issuers/?q=string' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"entityId": "string",
"iconImage": "string",
"allowed_template_tags": null
}'
{ "name": "string", "org": "string", "entityId": "string", "signatories": { "property1": "string", "property2": "string" }, "url": "string", "iconImage": "string", "allowed_template_tags": null }