AFSecurity Methods
- Last UpdatedNov 18, 2025
- 8 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFSecurity type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
  | AddIdentity(PISystem, AFSecurityIdentity, AFSecurityRights, AFSecurityRights, AFSecurityOperation) |
Add security for an AFSecurityIdentity to all objects in the PISystem.
|
| AddIdentity(PISystem, AFSecurityIdentity, IListAFSecurity, AFSecurityRights, AFSecurityRights, AFSecurityOperation, Boolean) |
Add security for an AFSecurityIdentity to specified objects in the PISystem.
|
| AddUser(PISystem, String, AFSecurityRights, AFSecurityRights, AFSecurityOperation) |
Add security for a user account to all objects in the PISystem.
|
| AddUser(PISystem, String, IListAFSecurity, AFSecurityRights, AFSecurityRights, AFSecurityOperation, Boolean) |
Add security for a user account to specified objects in the PISystem.
|
| AreEquivalent |
This method compares two lists of AFSecurityIdentity items for equivalence.
|
 | CheckSecurity(ClaimsIdentity) |
Evaluate the AFSecurityRights of the specified user for the object.
|
| CheckSecurity(WindowsIdentity) |
Evaluate the AFSecurityRights of the specified user for the object.
|
| CheckSecurity(IListAFSecurityIdentity, String) |
Evaluate the AFSecurityRights for the specified list of security identities for a user.
|
| CheckSecurity(PISystem, ClaimsIdentity, IListAFSecurityRightsToken) |
Evaluate the AFSecurityRights of the specified user for a list of
objects without needing to load the object.
|
| CheckSecurity(PISystem, WindowsIdentity, IListAFSecurityRightsToken) |
Evaluate the AFSecurityRights of the specified user for a list of
objects without needing to load the object.
|
| CheckSecurity(PISystem, IListAFSecurityIdentity, IListAFSecurityRightsToken, String) |
Evaluate the AFSecurityRights for the security identities of a user for a list of
objects without needing to load the object.
|
| ClearSecurityRightsCache |
Clears the cache used by the CheckSecurity Overload
methods.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetAccessControl | Obsolete.
Gets the access control security descriptor for the associated object.
|
| GetAccountNameForSID(SecurityIdentifier, Boolean) |
Helper method to return the Windows Account name for a security identifier (SID).
|
| GetAccountNameForSID(SecurityIdentifier, Boolean, String) |
Helper method to return the Windows Account name for a security identifier (SID) on a remote machine.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetIdForRoleName |
Helper method that returns the Id for an OpenID Connect Role.
|
| GetRoleNameForId |
Helper method that returns the Name for an OpenID Connect Role.
|
| GetSecurityEntries |
Get the security entries for this security object.
|
| GetSecurityString |
Gets a cached human readable string which represents the Access Rules of the security
for the associated object.
|
| GetSecurityString(Boolean) |
Gets a human readable string which represents the Access Rules of the security
for the associated object with the option to force getting the latest version
from the server.
|
| GetSIDForAccountName(String) |
Helper method that returns the security identifier (SID) for a windows account name.
|
| GetSIDForAccountName(String, String) |
Helper method that returns the security identifier (SID) for a windows account name on a remote machine.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetUserId |
Get the user identifier for the specified user name.
|
| GetUserIdentities(PISystem, ClaimsIdentity) |
Gets the list of AFSecurityIdentity identities for the specified user
on the PISystem server.
|
| GetUserIdentities(PISystem, WindowsIdentity) |
Gets the list of AFSecurityIdentity identities for the specified user
on the PISystem server.
|
| GetUserIdentityString(PISystem, ClaimsIdentity) |
Gets the security identity string for the specified user on the PISystem server.
|
| GetUserIdentityString(PISystem, WindowsIdentity) |
Gets the security identity string for the specified user on the PISystem server.
|
| RemoveIdentity(PISystem, AFSecurityIdentity) |
Remove all security rights for an AFSecurityIdentity from all objects in the PISystem.
|
| RemoveIdentity(PISystem, AFSecurityIdentity, IListAFSecurity, Boolean) |
Remove all security rights for an AFSecurity from the specified objects in the PISystem.
|
| RemoveUser(PISystem, String) |
Remove all security rights for a user account from all objects in the PISystem.
|
| RemoveUser(PISystem, String, IListAFSecurity, Boolean) |
Remove all security rights for a user account from the specified objects in the PISystem.
|
| SetAccessControl | Obsolete.
Sets the access control security descriptor for the associated object.
|
| SetOwner(ClaimsIdentity) |
Used to take ownership of the AFObject that is associated with this AFSecurity.
|
| SetOwner(NTAccount) |
Used to take ownership of the AFObject that is associated with this AFSecurity.
|
| SetSecurityString |
Sets the access control security rules for the associated object.
|
| ToString |
Returns a String that represents the current object.
(Overrides ObjectToString.) |
| VerifySignature |
Verify the signature of an assembly.
|
See Also
In This Topic
Related Links
- AddIdentity Method
- AddUser Method
- AreEquivalent Method
- CheckSecurity Method
- ClearSecurityRightsCache Method
- GetAccessControl Method
- GetAccountNameForSID Method
- GetIdForRoleName Method
- GetRoleNameForId Method
- GetSecurityEntries Method
- GetSecurityString Method
- GetSIDForAccountName Method
- GetUserId Method
- GetUserIdentities Method
- GetUserIdentityString Method
- RemoveIdentity Method
- RemoveUser Method
- SetAccessControl Method
- SetOwner Method
- SetSecurityString Method
- ToString Method
- VerifySignature Method