Remove recipients from a direct share in Dynatrace with the Document API and immediately revoke their access to the document.
| POST | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/document/v1/direct-shares/{id}/recipients/remove |
Remove one or multiple recipients from the share. The affected users immediately lose access to the document.
You can only remove recipients from shares which are 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. The maximum number of recipients is 1000.
Non-existing users or groups are ignored.
To execute this request, you need a platform token or OAuth access token with document:direct-shares:write scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| body | Remove | Input required to remove recipients from a direct-share. | body | Required |
RemoveDirectShareRecipients objectInput required to remove recipients from a direct-share.
| Element | Type | Description | Required |
|---|---|---|---|
| ids | string[] | - | Required |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"ids": ["string"]}
| Code | Description |
|---|---|
| 204 | The recipients have been removed. |
| 400 | - |
| 401 | - |
| 403 | - |
| 404 | - |
| 500 | - |
| 503 | - |
| default | - |