AFSecurityRightsToken Structure
- Last UpdatedNov 18, 2025
- 5 minute read
- PI System
- AF SDK 2024 R2
- Developer
A security rights token is used to check security for an object.
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
[SerializableAttribute] public struct AFSecurityRightsToken : IEquatable<AFSecurityRightsToken>
<SerializableAttribute> Public Structure AFSecurityRightsToken Implements IEquatable(Of AFSecurityRightsToken) Dim instance As AFSecurityRightsToken
[SerializableAttribute] public value class AFSecurityRightsToken : IEquatable<AFSecurityRightsToken>
[<SealedAttribute>] [<SerializableAttribute>] type AFSecurityRightsToken = struct interface IEquatable<AFSecurityRightsToken> end
The AFSecurityRightsToken type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | AFSecurityRightsToken(Guid, Int64, AFIdentity, Guid, AFSecurityItem, AFSecurityRights, AFSecurityRights) |
Creates a new instance of the security rights token.
|
| AFSecurityRightsToken(Guid, Int64, AFIdentity, Guid, Int32, AFSecurityItem, AFSecurityRights, AFSecurityRights) |
Creates a new instance of the security rights token.
|
Properties
| Name | Description | |
|---|---|---|
 | AddAdjustments |
The security rights adjustment to be added to the base security rights
for the instance of the object represented by this token.
|
| DatabaseId | |
| ObjectId |
The ID of the object represented by this token.
This value is used as the key in the dictionary returned from the
CheckSecurity(PISystem, WindowsIdentity, IListAFSecurityRightsToken)
method and does not have to be the ID of the actual object.
|
| ObjectIdentity |
The Identity of the object represented by this token.
|
| RemoveAdjustments |
The security rights adjustment to be removed to the base security rights
for the instance of the object represented by this token.
|
| SecurityId |
The SecurityId of the object represented by this token.
|
| SecurityItem |
The security item represented by this token. If Default,
then it represents the security for the object. Otherwise, it represents the security
for a collection of the object.
|
| SecurityOwnerId |
The security owner identifier representing the owner of the object represented by this token.
The GetUserId(PISystem, String) method can be used to set the value for this property.
If this property is not set, then the security for the owner security identity will not be evaluated.
|
Methods
| Name | Description | |
|---|---|---|
| Equals(Object) |
Determines whether the specified Object is equal to the current object.
(Overrides ValueTypeEquals(Object).) |
| Equals(AFSecurityRightsToken) |
Indicates whether the current object is equal to another object of the same type.
|
| GetHashCode |
Gets the hash code for this instance of the object which is suitable for use in hashing
algorithms and data structures like a hash table.
(Overrides ValueTypeGetHashCode.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString |
Returns a String that represents the current object.
(Overrides ValueTypeToString.) |
Operators
| Name | Description | |
|---|---|---|
  | Equality |
The equality operator (==) compares its operands to determine if they are equal.
|
| Inequality |
The inequality operator (!=) compares its operands to determine if they are not equal.
|
Remarks
A security rights token is used with the
CheckSecurity(PISystem, WindowsIdentity, IListAFSecurityRightsToken)
to check security for an object without needing to first load the object
from the server.