AssetServer GetSecurityIdentities

Retrieve security identities based on the specified criteria. By default, all security identities in the specified Asset Server are returned.

Request

GET assetservers/{webId}/securityidentities

URL Parameters

• webId

  The ID of the asset server to search. See WebID for more information.

• query

  The query string used for finding objects. The default is no query string. See Query String for more information.

• field

  Specifies which of the object's properties are searched. The default is 'Name'.

• sortField

  The field or property of the object used to sort the returned collection. The default is 'Name'. See Sort Field for more information.

• sortOrder

  The order that the returned collection is sorted. The default is 'Ascending'. See Sort Order for more information.

• maxCount

  The maximum number of objects to be returned. The default is 1000.

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

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": {}
}