PIAuthenticationMode Enumeration
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
The authentication mode to use when making an explicit connection
to a PIServer.
Namespace: OSIsoft.AF.PI
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public enum PIAuthenticationMode
Public Enumeration PIAuthenticationMode Dim instance As PIAuthenticationMode
public enum class PIAuthenticationMode
type PIAuthenticationMode
Members
| Member name | Value | Description | |
|---|---|---|---|
| WindowsAuthentication | 0 | Specifies that Windows Authentication should be used when making the connection. | |
| PIUserAuthentication | 1 | Specifies that PI User Authentication should be used when making the connection. | |
| OpenIDConnectAuthentication | 2 | Specifies that Claims Authentication should be used when making the connection. | |
| None | 3 | Specifies that the Authentication mode has not been initialized. |
Remarks
This enumeration is used to specify the authentication mode to use
when making an explicit connection to a PIServer.
When using WindowsAuthentication mode to connect to a
PIServer, the authentication only uses identity mappings
and does not utilize trusts defined with Windows credentials or any
other trusts that may be configured.
 Note |
|---|
| When prompting for credentials, the PIUserAuthentication mode is only allowed when the AllowExplicit option is set in the AuthenticationOptions setting. |