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)
Returns a single participant to the requesting party from the DSGO central participant registry, based on a iSHARE did organisation ID
Parties will use the central participant registry mainly to verify the status of a party in a certain role. In order to support this, query parameters to filter claims are added.
The returned information is sufficient for a party to determine if another party complies with legal and technical conditions of DSGO, and is active in a certain role.
The central participant registry MUST support a GET call to a /parties/{partyId} endpoint to retrieve a single DSGO participant in a partyInfo object. {partyId} must be a valid iSHARE did organisation ID
Request
Authorization
An access token is used in GET calls to the /parties/{partyId} endpoint. For more information, see Access Token.
The central participant registry MUST validate that a GET call to a /parties/{partyId} endpoint includes the “Authorization" header according to RFC 6750 and includes a valid access token
The central participant registry MUST validate that a GET request to the /parties/{partyId} endpoint only contains the query parameters as defined in the table below
The central participant registry MUST validate that the HTTP body of a GET request to the /parties/{partyId} endpoint contains at least a single query parameter.
Query parameter
Type
Description
Query parameter
Type
Description
type
Optional
String
MUST be the claim type. Enum with values frameworkCompliance , dataspaceMembership,frameworkRole , dataspaceRole
dataspaceId
Optional
String
MUST be the id of the data space when type is dataspaceMembership ordataspaceRole. Enum with value EU.DS.NL.DSGO
frameworkId
Optional
String
MUST be the id of the framework whentype is frameworkCompliance or frameworkRole. Enum with valuesiSHARE
roleId
Optional
String
MUST be the id of the role when type is dataspaceRole or frameworkRole. See the claim object for allowed values
status
Optional
String
MUST be the status of the claim. Enum with values Active, Pending, NotActive, Revoked.
format
Optional
String
Used to specify if the response is in plain JSON or a signed JWT. Enum with values json, jwt
The example below shows a request for party did:ishare:EU.NL.NTRNL-98765432 with type=dataspaceRole, dataspaceId=EU.DS.NL.DSGO and roleId=ServiceConsumer and status=Active:
> Authorization: Bearer IIeDIrdnYo2ngwDQYJKoZIhvcNAQELBQAwSDEZMBcGA1UEAwwQaVNIQ
GET /parties/did:ishare:EU.NL.NTRNL-98765432?type=dataspaceRole&dataspaceId=EU.DS.NL.DSGO&roleId=ServiceConsumer&status=Active
Responses
400 Bad Request
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 query parameters are either invalid or none of them were provided.
401 Unauthorized
When Authorization header is either missing, invalid or the access token has already expired.
404 Not Found
When a party is not found
200 OK
If successful, the response contains data providing the requested parties information in a partyToken. The partyToken is a signed JWT, which contains the claims as defined in the iSHARE JWT, and additionally contains a partyInfo object as defined here.
The response may also be the partyInfo object in plain JSON.
The response may also return zero claims, for instance if the query is filtered on active status but a party has all claims with status revoked
The central participant registry MUST offer a partyToken including a partyTnfo object in a response to a successful GET calls to the /parties/{partyId} endpoint
The central participant registry MAY also offer a plain JSON partyInfo object in a response to a successful GET call to the /parties/{partyId} endpoint
The example below shows the example response for the request example above: