PIAuthenticationOption Enumeration
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Defines the authentication options used when making a connection to a PIServer.
Namespace: OSIsoft.AF.PI
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public enum PIAuthenticationOption
Public Enumeration PIAuthenticationOption Dim instance As PIAuthenticationOption
public enum class PIAuthenticationOption
type PIAuthenticationOption
Members
| Member name | Value | Description | |
|---|---|---|---|
| Windows | 1 | Windows Integrated Security will be tried when making a connection to the PIServer. | |
| Trust | 2 | PI Data Archive trust mechanism will be tried when making a connection to the PIServer. | |
| OIDC | 7 | PI Data Archive OIDC mechanism will be tried when making a connection to the PIServer. | |
| AllowExplicit | 100 | An explicit login using PIUserAuthentication is allowed to be tried when making a connection to the PIServer. |
Remarks
The PIServer.Connect Overload methods
use the value of the AuthenticationOptions property to control
the authentication options when attempting to make a connection to a PIServer.
 Note |
|---|
| When connecting to a PIServer with an explicit login by prompting for credentials with the ConnectWithPrompt Overload method or by specifying a NetworkCredential with the Connect(NetworkCredential, AFConnectionPreference, PIAuthenticationMode) method, the AuthenticationOptions order will be ignored. Even if Windows is not listed, the WindowsAuthentication will be attempted if the user selects it. |