Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Retrieves information about the features available to the requesting party. In the DSGO, a data service can be considered as a specific feature.

Excerpt
nameget capabilities
Panel
panelIconId2705
panelIcon:white_check_mark:
panelIconText
bgColor#FFF0B3

Parties MUST support a GET call to a /capabilities endpoint to retrieve a list of their features (in acapabilities_info object).

Request

Authorization

An access token may be used in GET calls to the /capabilities endpoint. For more information, see Access Token. The /capabilities endpoint should only return the public endpoints if no access token is provided. If an access token is provided, the /capabilities endpoint will also provide the restricted endpoints.

...

For information about the parameters that are common to the trust framework’s API’s see Generic API Requirements.

Expand
titleExample request for a succesful GET /capabilities call
Code Block
languagejson
> Authorization: Bearer IIeDIrdnYo2ngwDQYJKoZIhvcNAQELBQAwSDEZMBcGA1UEAwwQaVNIQ

GET /capabilities

...

Successful, the response contains data providing the requested features of the party in a capabilities_token. The capabilities_token is a signed JWT, which contains the claims as defined in the Authentication JWT, and additionally contains a capabilities_info object.

...