Retrieves the details of a Share.

iModels Share API provides a way to publicly share an iModel. Each Share instance has a shareKey property which allows anonymous access to the shared iModel using iModels API. To use the shareKey to access the iModel one has to provide shareKey via Authorization header: Authorization: Basic {shareKey}, when calling iModels API.

All Share operations interact only with the Share instances that the calling user has created. E.g. querying iModel Shares will not return all the Shares iModel has, but only the Shares which were created by the user who is calling the API.

Authentication

---

Requires Authorization header with valid Bearer token for scope itwin-platform.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Authorization

---

User must have imodels_webview permission assigned at the iModel level. If iModel Role permissions at the iModel level are configured, then user must additionally have at least imodels_webview permission assigned at the iTwin level. If permissions at the iModel level are not configured, then user must have imodels_webview permission assigned at the iTwin level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given iTwin the iModel belongs to.

For more information please refer to Account Administrator documentation section on Access Control API documentation page.

Important: Share operations are in closed preview mode currently. Hence only selected applications can utilize the Share API.

Rate limits

---

All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.

{
    "share": {
        "id": "846e5f15-ac4a-4971-8160-580d95624f81",
        "displayName": "iModel Share name",
        "name": "iModel Share name",
        "expiresAt": "2020-10-20T10:51:33.1700000Z",
        "permission": "imodels_webview"
    }
}

{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

{
    "error": {
        "code": "iModelNotFound",
        "message": "Requested iModel is not available."
    }
}

{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}