AssetDatabase GetSecurityEntryByName
- Last UpdatedJun 15, 2023
- 1 minute read
- PI System
- PI Web API Reference
- Developer
AssetDatabase GetSecurityEntryByName
Retrieve the security entry of the specified security item associated with the asset database with the specified name.
Request
GET assetdatabases/{webId}/securityentries/{name}
URL Parameters
-
webId The ID of the asset database. See WebID for more information.
-
name The name of the security entry. For every backslash character (\) in the security entry name, replace with asterisk (*). As an example, use domain*username instead of domain\username.
-
securityItem The security item of the desired security entries information to be returned. If the parameter is not specified, security entries of the 'Default' security item will be returned. See Security Item 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. 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: The security entry matching the specified condition.
404: The security entry with the specified name is not found.
Sample Response Body
{
"Name": "domain\\user1",
"SecurityIdentityName": "domain\\user1",
"AllowRights": [
"Read",
"ReadData"
],
"DenyRights": [
"Write",
"Execute",
"Admin"
],
"Links": {}
}