VDX - DID Associations (0.1)
Download OpenAPI specification:Download
E-mail: info@sphereon.com License: Apache 2.0
Verifiable Data Exchange - DID Association Service
Creates an association between a party and a DID
Creates an association between a party and a DID and returns the association object
path Parameters
| did required | string Example: web:did:localhost The did associated with the party |
Request Body schema: application/json
| party | string The party that should be associated with the DID |
| partyType | string (PartyType) Enum: "GROUP" "USER" The type of the party to be associated with a DID |
| kid | string The key id of the DID |
| type | string (AssociationType) Value: "DID" The type of the Key Identifier (kid) |
Responses
Request samples
- Payload
Content type
application/json
{- "party": "finance",
- "partyType": "GROUP",
- "kid": "did:web:mydomain.com#key-1",
- "type": "DID"
}Response samples
- 202
- 400
Content type
application/json
{- "did": "did:web:mydomain.com",
- "party": "finance",
- "partyType": "GROUP",
- "kid": "did:web:mydomain.com#key-1",
- "type": "DID"
}List the associations between a party and a DID
Returns a list of association between parties and a DID
path Parameters
| did required | string Example: web:did:localhost The did associated with the entity |
Responses
Response samples
- 200
Content type
application/json
[- {
- "did": "did:web:mydomain.com",
- "party": "finance",
- "partyType": "GROUP",
- "kid": "did:web:mydomain.com#key-1",
- "type": "DID"
}
]Update the association between a party and a DID
Updates the association between a party and a DID
path Parameters
| did required | string Example: web:did:localhost The did associated with the party |
| associationId required | string Example: 624d7492c58642554607edd0 The association id |
Request Body schema: application/json
| party | string The party that should be associated with the DID |
| partyType | string (PartyType) Enum: "GROUP" "USER" The type of the party to be associated with a DID |
| kid | string The key id of the DID |
| type | string (AssociationType) Value: "DID" The type of the Key Identifier (kid) |
Responses
Request samples
- Payload
Content type
application/json
{- "party": "finance",
- "partyType": "GROUP",
- "kid": "did:web:mydomain.com#key-1",
- "type": "DID"
}Response samples
- 202
- 400
Content type
application/json
{- "did": "did:web:mydomain.com",
- "party": "finance",
- "partyType": "GROUP",
- "kid": "did:web:mydomain.com#key-1",
- "type": "DID"
}