latestOpenAPI 3.0.12026-08-188456240.4 KB

6e6982573ba6

List share information for alert

get/api/2.0/alerts/{objectId}/shares

Path parameters

objectIdinteger required

Alert ID to retrieve sharing information for

Response

Success

idinteger

ID of user or group to be shared to

typestring required

Share type

accessLevelinteger required

Share access level

namestring

Username + name or group name to be shared to. When sharing to a user, either id field or the combination of name, externalAuthId, and ssoUser have to be specified

externalAuthIdinteger

External authenticate ID to be shared to

ssoUserboolean

Whether or not user is SSO user

access_levelinteger

sso_userboolean

external_auth_idinteger

Example response

[
  {
    "type": "Users,Groups"
  }
]