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/

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_issuers_authority_create

Request

API View for managing issuer authorities (signatories).

This endpoint allows creating authorities/signatories that can be associated with issuers or specific credentials.

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

Methods: POST: Create a new issuer authority

POST Request Body: A JSON object containing authority details:

  • name (str, required): Name of the signatory
  • title (str, required): Title of the signatory
  • signature (str, required): URL to the signature image
  • org (str, optional): Organization identifier to associate with an issuer
  • entityId (str, optional): Issuer entity ID to associate with
  • credential (str, optional): Credential entity ID to associate with

Returns: POST: A JSON response containing the created authority: { "data": { "name": "John Smith", "title": "President", "signature": "https://example.com/signatures/john-smith.png" } }

Error Responses: 400 Bad Request: If the request data is invalid or missing required fields 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 issuer or credential doesn't exist 500 Internal Server Error: If an unexpected error occurs

Access Control:

  • Requires IsAdminUserOrStudentDRFMixin
  • Only authenticated users with appropriate permissions can manage authorities
Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Bodyrequired
namestring<= 254 charactersrequired
titlestring<= 254 charactersrequired
signaturestring(uri)<= 200 charactersrequired
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/issuers/authority/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "title": "string",
    "signature": "http://example.com"
  }'

Responses

Bodyapplication/json
namestring<= 254 charactersrequired
titlestring<= 254 charactersrequired
signaturestring(uri)<= 200 charactersrequired
Response
application/json
{ "name": "string", "title": "string", "signature": "http://example.com" }

credentials_public_assertions_retrieve

Request

Public endpoint to retrieve a specific credential assertion by its entity ID.

This endpoint allows public access to view a specific credential assertion without authentication.

Path Parameters: entity_id (str): The assertion entity ID

Returns: A JSON response containing the assertion details using the AssertionSerializer format

Error Responses: 404 Not Found:

  • If the assertion doesn't exist: Empty response with 404 status
  • If the assertion has been revoked: JSON with error detail and revocation reason 500 Internal Server Error: If an unexpected error occurs
Path
entity_idstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/credentials/public/assertions/{entity_id}/'

Responses

Bodyapplication/json
entityIdstringrequired
issuedOnstringrequired
credentialDetailsobjectread-onlyrequired
credentialDetails.​property name*stringadditional property
recipientobjectread-onlyrequired
recipient.​property name*stringadditional property
metadataany or null
courseobjectread-onlyrequired
course.​property name*stringadditional property
programobjectread-onlyrequired
program.​property name*stringadditional property
narrativestring or null
revokedboolean
revocationReasonstringrequired
acceptancestring(AcceptanceEnum)
  • Unaccepted - Unaccepted
  • Accepted - Accepted
  • Rejected - Rejected
Enum"Unaccepted""Accepted""Rejected"
expiresstringrequired
Response
application/json
{ "entityId": "string", "issuedOn": "string", "credentialDetails": { "property1": "string", "property2": "string" }, "recipient": { "property1": "string", "property2": "string" }, "metadata": null, "course": { "property1": "string", "property2": "string" }, "program": { "property1": "string", "property2": "string" }, "narrative": "string", "revoked": true, "revocationReason": "string", "acceptance": "Unaccepted", "expires": "string" }

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations