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

GET endpoints for more details #574

Open
entin-hun opened this issue Aug 21, 2024 · 0 comments
Open

GET endpoints for more details #574

entin-hun opened this issue Aug 21, 2024 · 0 comments

Comments

@entin-hun
Copy link

Background:
While DIDs provide a mechanism for uniquely identifying a subject, there is often a need for applications to retrieve more detailed information about the subject. This is especially relevant for systems that need to interact with external services or data repositories to obtain additional context or attributes related to the DID subject.

Proposal:
I propose extending the DID specification to include GET API endpoint fields. These fields will allow for the specification of API endpoints that can be queried to retrieve additional information about the subject. The fields should include details such as the URL of the endpoint, resource IDs, required authentication methods, and credentials (decrypted only for the privileged), similar to how integrations usually store connections.

Specific Changes:

•	Introduce a new getEndpoints field in the DID document, structured as an array to allow for multiple endpoints.
•	Each endpoint object should include:
•	url: The URL of the API endpoint.
•	resource_Id: The (required) field key where the resource (D)identifier should be passed.
•	authentication: Details on the required authentication method (e.g., API key, OAuth).
•	credentials: Information about the credentials needed to access the endpoint.
•	Example of how the DID document might look with GET API endpoint fields:

{ "@context": "https://www.w3.org/ns/did/v1", "id": "did:example:123456789abcdefghi", "getEndpoints": [ { "url": "https://api.example.com/resource", "resource_Id": "id", "authentication": "OAuth2", "credentials": "Bearer token" } ] }

Use Cases:

•	Enabling systems to dynamically retrieve additional information about a DID subject, such as current status, attributes, or related entities.
•	Facilitating the integration of DIDs with external data services, enhancing interoperability.
•	Supporting advanced use cases in sectors like IoT, supply chain management, and digital identity verification.

Impact:

•	This extension will make DIDs more versatile and applicable in environments where additional context about the subject is necessary.
•	By aligning with existing standards like OSLC and hypermedia, this proposal ensures compatibility with widely adopted practices in lifecycle management and service orchestration.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant