ibl-data-manager (3.59.0-ai-plus)

API View for managing individual credentials.

This endpoint allows retrieving, updating, and deleting specific credentials identified by their entity_id.

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: GET: Retrieve a specific credential PUT: Update a specific credential DELETE: Delete a specific credential

PUT Request Body: A JSON object containing credential details to update:

• name (str, optional): Credential name
• description (str, optional): Credential description
• credential_type (str, optional): Type of credential
• html_template (str, optional): HTML template for credential rendering
• css_template (str, optional): CSS template for credential styling
• icon_image (str, optional): URL to credential icon
• background_image (str, optional): URL to credential background
• thumbnail_image (str, optional): URL to credential thumbnail
• criteria_url (str, optional): URL to credential criteria
• criteria_text (str, optional): Text description of credential criteria
• issuing_signal (str, optional): Signal that triggers credential issuance

Returns: GET: A JSON response containing: { "status": {"success": true, "description": "Ok"}, "result": {credential object} }

PUT: A JSON response containing: { "status": {"success": true, "description": "Updated"}, "result": {credential object} }

DELETE: No content (204)

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

Access Control:

• Requires CredentialAssignmentPermission
• Users can only manage credentials they have permission to access

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

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