Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device.
Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)
Parties with role ParticipantRegistry can update the status of a dataspaceRole for parties they create and manage in the central participant registry with a PATCH to the /parties/{partyId}/claims/{claimId} endpoint.
The central participant registry MUST support a PATCH call to a /parties/{partyId}/claims/{claimId} endpoint.
Request
Authorization
An access token is used in PATCH calls to the /parties/{partyId}/claims/{claimId} endpoint. For more information, see Access Token.
The central participant registry MUST validate that a PATCH call to a /parties/{partyId}/claims/{claimId} endpoint includes the “Authorization" header according to RFC 6750 and includes a valid access token
The central participant registry MUST validate that a PATCH call to a /parties/{partyId}/claims/{claimId} endpoint has an existing iSHARE DID identifier (see OrganisationId) as partyId path parameter, and the id of an existing dataspaceRole claim in the claimId path parameter
The central participant registry MUST validate that the HTTP body of a PATCH request to the /parties/{partyId}/claims/{claimId} endpoint contains at least the status attribute as defined in the table below, formatted as JSON
Attribute
type
Description
Attribute
type
Description
status
Required
String
MUST be the new status of the party. Available values are Active, NotActive and Revoked.
endDate
Optional
String
Date and time which states when the adherence status ends. Must be in the future. Only applicable for a status change to Active.
If successful, the response contains data providing the updated dataspaceRoleclaim in a claimToken. The claimToken is a signed JWT, which contains the claims as defined in the iSHARE JWT, and additionally contains a claim object as defined here.
The trust framework catalogue MUST include a claimToken including the updated claim object in a response to a successful PATCH call to the /parties/{partyId}/claims/{claimId} endpoint
A successful status update on a claim results in a new claim record with a new status, claim id and startDate
When do we create a new claimId?
If the update of the claim is updating the status, we create a new record with a new claimId for audit reasons. The old claimId has the previous status.
If the update of the claim is adding the endDate, we do not create a new record. The claimId is not updated.
When Authorization header is provided, but the token format is invalid (for example, not Bearer). Additionally, a 400 should be returned when the provided access token is valid, but the request body content is invalid.
Also a PATCH request for dataspaceRole claims with statusPending will result in a 400. Only the DSGO central participant registry can change a Pending (after the legal adherence has been established by signing the DSGO framework agreement)
401 Unauthorized
When Authorization header is either missing, invalid or the access token has already expired.
403 Forbidden
When client is authenticated but not allowed to perform the action