ibl-data-manager (3.59.0-ai-plus)
API for iblai
Request
Endpoint to retrieve and update a specific credential assertion.
This endpoint allows retrieving details of a specific credential assertion and updating its status (e.g., revoking it).
Path Parameters: org (str): The organization/tenant identifier user_id (str): The user ID making the request entity_id (str): The assertion entity ID
Methods: GET: Retrieve assertion details PUT: Update assertion status (e.g., revoke)
PUT Request Body: A JSON object containing:
- revoked (bool): Set to true to revoke the assertion
- revocationReason (str): Reason for revocation (required when revoking)
Returns: GET: A JSON response containing the assertion details using the AssertionSerializer format PUT: A JSON response containing the updated assertion 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 assertion doesn't exist 500 Internal Server Error: If an unexpected error occurs
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/assertions/{entity_id}
https://base.manager.iblai.app/api/credentials/orgs/{org}/users/{user_id}/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/orgs/{org}/users/{user_id}/assertions/{entity_id}' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "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" }
Request
Endpoint to retrieve and update a specific credential assertion.
This endpoint allows retrieving details of a specific credential assertion and updating its status (e.g., revoking it).
Path Parameters: org (str): The organization/tenant identifier user_id (str): The user ID making the request entity_id (str): The assertion entity ID
Methods: GET: Retrieve assertion details PUT: Update assertion status (e.g., revoke)
PUT Request Body: A JSON object containing:
- revoked (bool): Set to true to revoke the assertion
- revocationReason (str): Reason for revocation (required when revoking)
Returns: GET: A JSON response containing the assertion details using the AssertionSerializer format PUT: A JSON response containing the updated assertion 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 assertion doesn't exist 500 Internal Server Error: If an unexpected error occurs
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
Unaccepted- UnacceptedAccepted- AcceptedRejected- Rejected
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/assertions/{entity_id}
https://base.manager.iblai.app/api/credentials/orgs/{org}/users/{user_id}/assertions/{entity_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/assertions/{entity_id}' \
-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"
}'{ "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" }
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/assignments/{assignment_id}
https://base.manager.iblai.app/api/credentials/orgs/{org}/users/{user_id}/assignments/{assignment_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}/assignments/{assignment_id}' \
-H 'Authorization: YOUR_API_KEY_HERE'