Analysis GetSecurity

Get the security information of the specified security item associated with the Analysis for a specified user.

Request

GET analyses/{webId}/security

URL Parameters

• webId

  The ID of the Analysis for the security to be checked. See WebID for more information.

• userIdentity

  The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned. See User Identity for more information.

• forceRefresh

  Indicates if the security cache should be refreshed before getting security information. The default is 'false'.

• selectedFields

  List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned. See Selected Fields for more information.

• webIdType

  Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType". See WebID Type for more information.

Status Codes

200: Security rights.

400: An invalid or local account is specified as the user identity.

401: Access denied for the specified user identity.

409: Unsupported when using Anonymous authentication method.

502: Failed to retrieve the specified user identity.

Sample Response Body

{
  "Items": [
    {
      "OwnerWebId": "I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA",
      "SecurityItem": "Default",
      "UserIdentity": "domain\\user",
      "Links": {},
      "CanAnnotate": true,
      "CanDelete": true,
      "CanExecute": true,
      "CanRead": true,
      "CanReadData": true,
      "CanSubscribe": true,
      "CanSubscribeOthers": true,
      "CanWrite": true,
      "CanWriteData": true,
      "HasAdmin": true,
      "Rights": [
        "Read",
        "WriteData"
      ]
    },
    {
      "OwnerWebId": "I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA",
      "SecurityItem": "Default",
      "UserIdentity": "domain\\user",
      "Links": {},
      "CanAnnotate": true,
      "CanDelete": true,
      "CanExecute": true,
      "CanRead": true,
      "CanReadData": true,
      "CanSubscribe": true,
      "CanSubscribeOthers": true,
      "CanWrite": true,
      "CanWriteData": true,
      "HasAdmin": true,
      "Rights": [
        "Read",
        "WriteData"
      ]
    }
  ],
  "Links": {}
}