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)
Retrieves a list of all participants to the requesting party from the central participant registry.
The central participant registry MUST support a GET call to a /parties endpoint to retrieve a list of DSGO participants in a parties_info object as payload value of a Authenticatie JWT.
Request
Authorization
An access token is used in GET calls to the /parties endpoint. For more information, see Access Token.
The central participant registry MUST validate that a GET call to a /parties endpoint includes the “Authorization" header according to RFC 6750 and includes a valid access token
Query Parameters
For information about the query parameters that are common to the trust framework’s API’s see Generic API Requirements.
The central participant registry MUST validate that the HTTP body of a GET request to the /parties endpoint only contains the parameters as defined in the table below
The central participant registry MUST validate that the HTTP body of a GET request to the /parties endpoint contains at least a single parameter.
Query parameter
Type
Description
Query parameter
Type
Description
name
Optional
string
Used to search by a party’s name. MUST be the party’s name or contain a single * as wildcard instead
partyId
Optional
string
Used to search by a party’s identifier. MUST contain a valid DSGO Organisation ID
activeOnly
Optional
boolean
Used to search all active parties. MUST be equal to null, false or true. If null is provided, then it will not affect the query and will return both active and inactive parties. If false is provided, then the query will return inactive parties. If true is provided, then the query will return active parties
page
Optional
integer
Requests to return a specific page
size
Optional
integer
Sets the page size (number of items per page)
format
Optional
string
Used to specify if the response is in plain JSON or a signed JWT. Enum with values json, jwt
> Authorization: Bearer IIeDIrdnYo2ngwDQYJKoZIhvcNAQELBQAwSDEZMBcGA1UEAwwQaVNIQ
GET /parties?activeOnly=true&page=2&size=10
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.
200 OK
If successful, the response contains data providing the requested parties information in a partiesToken. The partiesToken is a signed JWT, which contains the claims as defined in the iSHARE JWT, and additionally contains a partiesInfo object as defined here.
The response may also be the partiesInfo object in plain JSON.
The central participant registry MUST offer a partiesToken including a partiesInfo object in a response to a successful GET call to the /parties endpoint
The central participant registry MAY also offer a plain JSON partiesInfo object in a response to a successful GET call to the /parties endpoint