ibl-data-manager (3.59.0-ai-plus)
API for iblai
Request
API View for managing individual issuers.
This endpoint allows retrieving, updating, and deleting specific issuers identified by their entity_id or org identifier.
Path Parameters: org (str): The organization/tenant identifier user_id (str): The user ID making the request entity_id (str): The issuer entity ID or org identifier
Methods: GET: Retrieve a specific issuer PUT: Update a specific issuer DELETE: Delete a specific issuer
PUT Request Body: A JSON object containing issuer details to update:
- name (str, optional): 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 the issuer details: [ { "name": "Example University", "org": "example-university", "entityId": "abc123", "signatories": [...], "url": "https://example.com", "iconImage": "https://example.com/logo.png", "allowed_template_tags": [...] } ]
PUT: A JSON response containing the updated issuer details: [ { "name": "Example University", "org": "example-university", "entityId": "abc123", "signatories": [...], "url": "https://example.com", "iconImage": "https://example.com/new-logo.png", "allowed_template_tags": [...] } ]
DELETE: A JSON response indicating success: { "status": {"success": true, "description": "Deleted"} }
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 issuer 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/{entity_id}
https://base.manager.iblai.app/api/credentials/orgs/{org}/users/{user_id}/issuers/{entity_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/issuers/{entity_id}' \
-H 'Authorization: YOUR_API_KEY_HERE'
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
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/credentials/public/assertions/{entity_id}/
https://base.manager.iblai.app/api/credentials/public/assertions/{entity_id}/
- 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/public/assertions/{entity_id}/'
{ "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" }