Capabilities
The /capabilities
endpoint is required for every participant that provides services:
iSHARE Satellite
Authorisation Registry
Service Provider
Identity Provider
The endpoint returns iSHARE capabilities of the iSHARE party. The server response is an iSHARE signed JSON Web Token.
Depending on whether or not an Access Token is provided to the capabilities endpoint, the endpoint must return public or public and restricted endpoints. in detail:
If an access token IS NOT provided
Return public endpoints, including the Access Token endpoint
If an access token IS provided
Return public endpoints, including the Access Token endpoint
Return restricted endpoints
Any endpoints that are not intended to be part of the capabilities to be used by iSHARE roles (out of scope of iSHARE) must not be included in the capabilities endpoint return.
Response Model
Decoded capabilities_token parameters:
capabilities_info
Object. Root level. Contains information about capabilities.party_id
String. Contained incapabilities_info
. Party ID, also known as EORI number of the party which provides the capabilities info.ishare_roles
Array of Objects. Contained incapabilities_info
. Contains array ofrole
objects that provide the information about the roles of the party in iSHARE.role
String. Contained inishare_roles
. Should be on the following values: ServiceConsumer, ServiceProvider, EntitledParty, AuthorisationRegistry, IdentityProvider, IdentityBroker, iShareSatellite.
supported_versions
Array of Objects. Contained incapabilities_info
. Contains information about supported version endpoints for each version.version
String. Contained insupported_versions
. Version of the system which is under support.supported_features
Array of Objects. Contained insupported_versions
. Contains a list of supported features for different access levels.public
Array of Objects. Contained insupported_features
. Contains supported public features.id
String. Contained in the object ofpublic
. Unique identifier of the feature.feature
String. Contained in the object ofpublic
. Friendly name of the feature.description
String. Contained in the object ofpublic
. Short description about the feature.url
String. Contained in the object ofpublic
. URL to the feature.token_endpoint
String. Contained in the object ofpublic
. Optional. URL where access token for the feature could be retrieved. This is optional because if feature is access token, it is not needed to mention it twice.
restricted
Array of Objects. Contained insupported_features
. Optional. Contains supported restricted features. The structure and parameters are exactly the same as defined inpublic
parameter above. It should only be shown to the parties which provided a valid access token. If an access token was not provided or restricted endpoints does not exist, this value can be not returned, empty or null.
Example request
Example response
The response contains an encoded JWT, which looks like this:
After decoding, the example content of the JWT looks like this:
Note
This page must be considered part of the iSHARE Trust Framework
Last updated