Share tokens

Introduction

When records are made available via the "Shares" functionality, a unique Share Token can be generated. This token is a JWT that encapsulates the necessary permissions to interact with the objects within that specific share.

Obtaining a share token

To obtain a JWT for accessing a specific share, you must exchange a Share ID for a Share Token. This is done by making a POST request to the /shares/{shareId}/token endpoint.

Note that you must already be an authenticated user to perform this action.

Endpoint

URL Parameters

• :shareId (string, required) - The unique identifier of the share

Example Response Body:

The value of the ShareToken property is the JWT. You will use this token in the Authorization header for all subsequent API requests related to this share.

Using the share token

A critical aspect of using the Share Token is that all API requests must be routed through the mediahaven-rest-api/v2-jwt/ path instead of the mediahaven-rest-api/v2/ path.

Example

Suppose you want to retrieve the details of a record, and the standard endpoint is:

To access this endpoint using your Share Token, you would modify the request path as follows:

Therefore, a complete curl request would look like this: