Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backend REST API Implementation for Fetching Company Owned Verified Credentials #71

Open
jjeroch opened this issue Apr 21, 2024 · 0 comments
Assignees
Labels
Sub-task A small piece of work that's part of a larger task.

Comments

@jjeroch
Copy link
Contributor

jjeroch commented Apr 21, 2024

Summary:

Implement a backend REST API endpoint that allows fetching company owned verified credentials from the credential issuer component. This API endpoint should return credentials regardless of their status.

Suggested Endpoint: GET /api/issuer/owned-credentials

Requirements:

  • The API endpoint should be implemented in the backend system.
  • The endpoint should be designed to retrieve company owned verified credentials.
  • The response from the endpoint should include the following information for each credential:
    • Credential Type: The type of the credential.
    • Status: The current status of the credential.
    • Expiry Date: The date when the credential will expire.
    • Authority: The authority responsible for issuing the credential.

Additional Information:

  • The endpoint should be secured with appropriate authentication and authorization mechanisms. permission view_credential_requests
  • The response includes only those VCs which are owned by my company - I cant view VCs of others
  • The response should be in a standardized format, preferably JSON.
  • The endpoint should handle any potential errors gracefully and provide appropriate error messages.
    • 400
    • 404
    • 401
    • 500
    • 501
    • 502
    • 503
  • in case no vcs are available, respond with an empty array

Acceptance Criteria:

  • The API endpoint should be successfully implemented and tested.
  • The endpoint should return the required information for each company owned verified credential.
  • The response should be correctly formatted and include the specified fields.
  • The endpoint should handle authentication and authorization properly.
  • The endpoint should handle errors and provide meaningful error messages.
  • Unit tests for empty response and multiple VCs are implemented. As well as mutliple VCs of the same type
@jjeroch jjeroch added the Sub-task A small piece of work that's part of a larger task. label Apr 21, 2024
Phil91 added a commit that referenced this issue Apr 24, 2024
* add endpoint /api/issuer/owned-credentials to fetch all credentials for a specific endpoint

Refs: #71
@jjeroch jjeroch added this to the Release 24.05 milestone Apr 24, 2024
Phil91 added a commit that referenced this issue Apr 27, 2024
* add endpoint /api/issuer/owned-credentials to fetch all credentials for a specific endpoint

Refs: #71
Phil91 added a commit that referenced this issue Apr 27, 2024
* fix(callback): set the correct base address for the callback
* fix(schema): adjust membership and framework schemas
* feat(api): add new endpoint to fetch own credentials
* add endpoint /api/issuer/owned-credentials to fetch all credentials for a specific company
* fix: adjust wallet configuration

Refs: #71
Reviewed-By: Norbert Truchsess <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Sub-task A small piece of work that's part of a larger task.
Projects
Status: IN REVIEW
Development

No branches or pull requests

2 participants