search

Versions

circle-info

This page must be considered part of the iSHARE Framework

This page is considered normative and is therefore compliant with RFC 2119.

hashtag
Retrieves active and planned versions of iSHARE

get
/[v2.1.1]/versions

Retrieves active and planned versions of iSHARE. By default returns current state. Server response is an iSHARE signed JSON Web Token. Please refer to the models 'jwt_header' and 'jwt_payload_versions_token' which indicate what the decoded response will look like.

Authorizations
AuthorizationstringOptional

OAuth 2.0 authorization based on bearer token. MUST contain “Bearer “ + access token value. Must be provided if restricted endpoints are needed.

Responses
get
/[v2.1.1]/versions
200

OK

hashtag
Response model

The model of the versions_token JWT response is available on the iSHARE OpenAPI documentationarrow-up-right.

Decoded versions_token parameters:

It contains iSHARE compliant JWT claims. In addition to that it also contains the following parameters:

  • versions_info

    Array of Objects. Root level.

    Contains collection of trusted certificate authorities.

    • version_name

      String. Contained in the object of versions_info.

      Version name. Expected format should be {major}.{minor}.{patch}.

    • valid_from

      Timestamp (ISO 8601). Contained in the object of versions_info.

      UTC timestamp which states since when version is valid.

    • valid_to

      Timestamp (ISO 8601). Contained in the object of versions_info.

      UTC timestamp which states till when version is valid.

    • version_status

      String. Contained in the object of versions_info.

      Status of the version. Available values are active, planned and deprecated.

hashtag
Example request

hashtag
Example response

The response contains an encoded JWT, which looks like this:

After decoding, the example content of the JWT looks like this:

PreviousTrusted listNextData Spaces

Last updated