API View for managing credentials across a platform.

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

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

Query Parameters:

Platform identification

platform_org (str, optional): Alternative platform identifier (takes precedence over URL org)

Pagination

page (int, optional): Page number (default: 1) page_size (int, optional): Items per page (default: 10, max: 100)

Filtering and search

search (str, optional): Search term to filter credentials by name or description course (str, optional): Course ID to filter credentials associated with a specific course program (str, optional): Program ID to filter credentials associated with a specific program

Methods: GET: Retrieve credentials with filtering and pagination POST: Create a new credential

POST Request Body: A JSON object containing credential details:

• name (str): Credential name
• description (str, optional): Credential description
• issuer (str): Issuer entity ID
• 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": { "next": "URL to next page", "previous": "URL to previous page", "count": 42, "data": [ {credential object}, {credential object}, ... ], "num_pages": 5, "page_number": 1, "max_page_size": 100 } }

POST: A JSON response containing: { "status": {"success": true, "description": "Created"}, "result": {credential 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 CredentialAssignmentPermission
• Only public credentials are returned by default

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

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