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

API View for managing credential issuers.

This endpoint allows creating and retrieving issuers for a specific organization/tenant, with support for filtering and pagination.

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

Query Parameters: q (str, optional): Search term to filter issuers by name limit (int, optional): Number of results per page (default: 50) offset (int, optional): Starting position for pagination

Methods: GET: Retrieve issuers with filtering and pagination POST: Create a new issuer

POST Request Body: A JSON object containing issuer details:

• name (str): 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: { "status": {"success": true, "description": "Ok"}, "result": { "next": "URL to next page", "previous": "URL to previous page", "count": 10, "data": [ {issuer object}, {issuer object}, ... ], "num_pages": 1, "page_number": 1, "max_page_size": 1000 } }

POST: A JSON response containing: { "status": {"success": true, "description": "Created"}, "result": {issuer object} }

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 platform 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

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

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