AF SDK Reference

PIServer.CurrentUserIdentityString Property

Save PDF

TABLE OF CONTENTS

PIServer.CurrentUserIdentityString Property

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Gets the security identity string of the person who is currently logged on to the PIServer server.

Namespace: OSIsoft.AF.PI
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public string CurrentUserIdentityString { get; }

Public ReadOnly Property CurrentUserIdentityString As String
	Get

Dim instance As PIServer
Dim value As String

value = instance.CurrentUserIdentityString

public:
property String^ CurrentUserIdentityString {
	String^ get ();
}

member CurrentUserIdentityString : string with get

Property Value

Type: String
The security identity string of the person who is currently logged on to the PIServer server.

Remarks

The returned string includes the CurrentUserName along with the list of CurrentUserIdentities within parentheses and separated by a vertical bar. If not connected to the PIServer, then accessing this property will NOT automatically connect to the server. When not connected, this property will return a string indicating that it is not currently connected to the server.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7

AF SDK Reference