Skip to content
API Reference
/
credentials
/
credentials_orgs_users_assertions_create

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_assertions_retrieve_3

Request

Endpoint to issue and retrieve credential assertions for a specific credential.

This endpoint allows issuing new credential assertions and retrieving existing assertions for a specific credential.

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

Methods: POST: Issue a new credential assertion GET: Retrieve assertions for a specific credential

POST Request Body: A JSON object containing recipient information and any additional metadata required for issuing the credential.

Returns: POST: A JSON response containing the created assertion using the AssertionSerializer format GET: A paginated list of assertions using the AssertionSerializer format

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 credential doesn't exist 500 Internal Server Error: If an unexpected error occurs

Security
PlatformApiKeyAuthentication
Path
entity_idstringrequired
orgstringrequired
user_idstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/{entity_id}/assertions/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
nextstringrequired
previousstringrequired
countintegerrequired
num_pagesintegerrequired
page_numberintegerrequired
max_page_sizeintegerrequired
dataArray of objects(Assertion)required
data[].​entityIdstringrequired
data[].​issuedOnstringrequired
data[].​credentialDetailsobjectread-onlyrequired
data[].​credentialDetails.​property name*stringadditional property
data[].​recipientobjectread-onlyrequired
data[].​recipient.​property name*stringadditional property
data[].​metadataany or null
data[].​courseobjectread-onlyrequired
data[].​course.​property name*stringadditional property
data[].​programobjectread-onlyrequired
data[].​program.​property name*stringadditional property
data[].​narrativestring or null
data[].​revokedboolean
data[].​revocationReasonstringrequired
data[].​acceptancestring(AcceptanceEnum)
  • Unaccepted - Unaccepted
  • Accepted - Accepted
  • Rejected - Rejected
Enum"Unaccepted""Accepted""Rejected"
data[].​expiresstringrequired
Response
application/json
{
  "next": "string",
  "previous": "string",
  "count": 0,
  "num_pages": 0,
  "page_number": 0,
  "max_page_size": 0,
  "data": [
    { … }
  ]
}

credentials_orgs_users_assertions_create

Request

Endpoint to issue and retrieve credential assertions for a specific credential.

This endpoint allows issuing new credential assertions and retrieving existing assertions for a specific credential.

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

Methods: POST: Issue a new credential assertion GET: Retrieve assertions for a specific credential

POST Request Body: A JSON object containing recipient information and any additional metadata required for issuing the credential.

Returns: POST: A JSON response containing the created assertion using the AssertionSerializer format GET: A paginated list of assertions using the AssertionSerializer format

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 credential doesn't exist 500 Internal Server Error: If an unexpected error occurs

Security
PlatformApiKeyAuthentication
Path
entity_idstringrequired
orgstringrequired
user_idstringrequired
Body
required
entityIdstringrequired
issuedOnstringrequired
metadataany or null
narrativestring or null
revokedboolean
revocationReasonstringrequired
acceptancestring(AcceptanceEnum)
  • Unaccepted - Unaccepted
  • Accepted - Accepted
  • Rejected - Rejected
Enum"Unaccepted""Accepted""Rejected"
expiresstringrequired
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/{entity_id}/assertions/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "entityId": "string",
    "issuedOn": "string",
    "metadata": null,
    "narrative": "string",
    "revoked": true,
    "revocationReason": "string",
    "acceptance": "Unaccepted",
    "expires": "string"
  }'

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"
}

credentials_orgs_users_assertions_bulk_create

Request

Endpoint to issue credential assertions in bulk for a specific credential.

This endpoint allows issuing credential assertions to multiple users at once.

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

POST Request Body: A JSON object containing:

  • users (list): List of usernames to issue the credential to
  • Additional metadata required for issuing the credential

Returns: A JSON response containing: { "skipped": ["username1", "username3"], // Users that were skipped (e.g., already have the credential) "issued": ["username2", "username4"] // Users that were successfully issued the credential }

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 credential doesn't exist 500 Internal Server Error: If an unexpected error occurs

Security
PlatformApiKeyAuthentication
Path
entity_idstringrequired
orgstringrequired
user_idstringrequired
Body
required
skippedArray of anyrequired
issuedArray of anyrequired
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/{entity_id}/assertions/bulk/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "skipped": [
      null
    ],
    "issued": [
      null
    ]
  }'

Responses

Bodyapplication/json
skippedArray of anyrequired
issuedArray of anyrequired
Response
application/json
{
  "skipped": [
    null
  ],
  "issued": [
    null
  ]
}

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

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