List the users who claimed an environment share in Dynatrace with the Document API, using pagination parameters when needed.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/document/v1/environment-shares/{id}/claimers |
Retrieve a share's claimers.
The share must be accessible to you. Shares accessible to you include those of your own documents, as well as those of reshareable documents owned by other users to which you have write access.
You can control the result's pagination via the pageKey, page and pageSize parameters.
Note, that at the moment we offer a naive pagination, and therefore interim document mutations and/or an insufficient sort clause, if provided, can lead to result inconsistencies (such as duplicates, missing entries).
To execute this request, you need a platform token or OAuth access token with document:environment-shares:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| id | string | Environment-share id. | path | Required |
| page-key | string | The page key is used to query results from the next page.
You get a | query | Optional |
| page | integer | The page parameter is used to directly access a specific page. The value of the page parameter, if specified, has to be a value greater than zero. If the value of the page parameter exceeds the highest available page on the backend, an empty page is returned. | query | Optional |
| page-size | integer | The page size which defines the requested number of result entries. You can request a maximum of 1000 result entries. If this parameter is omitted, the default value of 20 will be used. | query | Optional |
| admin-access | boolean | Indicates whether the operation should be performed with elevated permissions - additionally requires document:documents:admin. If provided, the user effectively operates as owner of all documents. This isn't supported for ready-made documents. | query | Optional |
| Code | Description |
|---|---|
| 200 | - |
| 401 | - |
| 403 | - |
| 404 | - |
| 500 | - |
| 503 | - |
| default | - |