Try it free

Add recipients to a direct share

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026

Add recipients to a direct share in Dynatrace with the Document API so selected SSO users and groups gain access immediately.

POSTSaaShttps://{your-environment-id}.apps.dynatrace.com/platform/document/v1/direct-shares/{id}/recipients/add

Overview

Add one or multiple SSO-users and/or SSO-groups to this share. The affected users immediately gain access to the document.

You can only add recipients to 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.

The validity of the SSO-users and SSO-groups isn't verified. It's technically possible, albeit pointless, to add non-existing users and groups.

Already added users or groups are ignored.

Authentication

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.

Parameters

ParameterTypeDescriptionInRequired
bodyAddDirectShareRecipients

Input required to add recipients to a direct-share.

bodyRequired

Request body objects

The AddDirectShareRecipients object

Input required to add recipients to a direct-share.

ElementTypeDescriptionRequired
recipientsSsoEntity[]

An array of SSO entities (users and/or groups) to add to this share. They immediately get access to the document.

Already added entities are ignored.

Required

The SsoEntity object

A SSO user or SSO group.

ElementTypeDescriptionRequired
idstring

SSO id of a user or group.

Required
typestring

Type of the SSO entity - either user or group.

Required

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
"recipients": [
{
"id": "441664f0-23c9-40ef-b344-18c02c23d789",
"type": "group"
}
]
}

Response

Response codes

CodeDescription
204

The recipients have been added.

400-
401-
403-
404-
500-
503-
default-
Related tags
Platform APIDynatrace Platform