AssetServer GetSecurityIdentitiesForUser

Retrieve security identities for a specific user.

Request

GET assetservers/{webId}/securityidentities

URL Parameters

• webId

  The ID of the server. See WebID for more information.

• userIdentity

  The user identity to search for. See User Identity for more information.

• 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.

• 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: A list of security identities for the specified user.

400: Unsupported security item; an invalid or local account is specified as the user identity.

401: Access denied for the specified user identity.

502: Failed to retrieve the specified user identity.

Sample Response Body

{
  "Items": [
    {
      "WebId": "I1SIDqD5loBNH0erqeqJodtALASe6l8zgYokqdeeFilFI9tw",
      "Id": "f3a5ee49-1838-4aa2-9d79-e16294523db7",
      "Name": "MySecurityIdentity",
      "Description": "",
      "Path": "\\\\MyAssetServer\\SecurityIdentities[MySecurityIdentity]",
      "IsEnabled": true,
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/securityidentities/I1SIDqD5loBNH0erqeqJodtALASe6l8zgYokqdeeFilFI9tw"
      }
    },
    {
      "WebId": "I1SIDqD5loBNH0erqeqJodtALASe6l8zgYokqdeeFilFI9tw",
      "Id": "f3a5ee49-1838-4aa2-9d79-e16294523db7",
      "Name": "MySecurityIdentity",
      "Description": "",
      "Path": "\\\\MyAssetServer\\SecurityIdentities[MySecurityIdentity]",
      "IsEnabled": true,
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/securityidentities/I1SIDqD5loBNH0erqeqJodtALASe6l8zgYokqdeeFilFI9tw"
      }
    }
  ],
  "Links": {}
}