Click or drag to resize
OSIsoft, LLC

AFSecurityRights Enumeration

The AFSecurityRights is an enumeration of the possible values for specifying security access rights of objects.

Namespace:  OSIsoft.AF
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 2.10.6.195
Syntax
[FlagsAttribute]
public enum AFSecurityRights
Members
  Member nameValueDescription
None0 There are no security rights granted to the associated object.
All65535 All security rights have been granted to the associated object.
Read1 There is read access to the associated object. Read security rights are required to view the object in client applications and within collections in the AF SDK.
Write2 There is write access to the associated object. Write security rights are required to CheckOut the object for modifications either directly or through another action that may cause these actions.
Delete4 There is delete permission to the associated object. Delete security rights are required to delete the object, either directly or indirectly by removing it from other objects.
Execute8 There is execute permission on the associated object. Execute security rights are required to queue backfilling or recalculation of analyses in the AFAnalysisService. It is also required to perform most actions on an AFCase.
Admin16 There is administration permission on the associated object. Administration security rights are required to change the security settings of an object, and to force an UndoCheckOut(Boolean) on an object that is checked out to another user. Administration security rights are also required to Lock or Unlock an AFEventFrame. Having the administration permission on the PISystem grants all rights to the system and all objects within the system including all databases.
ReadData32 There is read data access to the associated object. ReadData security rights are required to read AFAttribute non-configuration values (IsConfigurationItem is ). ReadData security rights can also affect the following objects (see AFSecurity for more information): AFElement, AFModel, AFNotification, AFEventFrame, AFTransfer, and AFCase.
WriteData64 There is write data access to the associated object. WriteData security rights are required to write AFAttribute non-configuration values (IsConfigurationItem is ). WriteData security rights can also affect the following objects (see AFSecurity for more information): AFEventFrame, AFTransfer, and AFCase.
Subscribe128 There is subscribe permission on the associated object. Subscribe security rights are required to subscribe and unsubscribe to an AFNotification.
SubscribeOthers256 There is subscribe other permission on the associated object. SubscribeOther security rights are required to subscribe and unsubscribe other users to an AFNotification.
Annotate512 There is annotate permission on the associated object. Annotate security rights are required to annotate or acknowledge an AFEventFrame.
ReadWrite3 There is read and write access to the associated object.
ReadWriteData96 There is read data and write data access to the associated object.
CanAnnotate This extension method determines if the current user has Annotate rights on the object.
CanDelete This extension method determines if the current user has Delete rights on the object.
CanExecute This extension method determines if the current user has Execute rights on the object.
CanRead This extension method determines if the current user has Read access to the object.
CanReadData This extension method determines if the current user has ReadData access to the object.
CanSubscribe This extension method determines if the current user has Subscribe rights on the object.
CanSubscribeOthers This extension method determines if the current user has SubscribeOthers rights on the object.
CanWrite This extension method determines if the current user has Write access to the object.
CanWriteData This extension method determines if the current user has WriteData access to the object.
HasAdmin This extension method determines if the current user has Admin rights on the object.
Remarks
This enumeration is used by the AFSecurity class to control security rights to IAFSecurable objects.
Version Information

AFSDK

Supported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6, 2.5, 2.4
See Also
Enabling Operational Intelligence