AF SDK Reference

AFSecurity.GetUserIdentityString Method (PISystem, ClaimsIdentity)

Save PDF

TABLE OF CONTENTS

AFSecurity.GetUserIdentityString Method (PISystem, ClaimsIdentity)

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Gets the security identity string for the specified user on the PISystem server.

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

Syntax

public static string GetUserIdentityString(
	PISystem system,
	ClaimsIdentity userIdentity
)

Public Shared Function GetUserIdentityString ( 
	system As PISystem,
	userIdentity As ClaimsIdentity
) As String

Dim system As PISystem
Dim userIdentity As ClaimsIdentity
Dim returnValue As String

returnValue = AFSecurity.GetUserIdentityString(system, 
	userIdentity)

public:
static String^ GetUserIdentityString(
	PISystem^ system, 
	ClaimsIdentity^ userIdentity
)

static member GetUserIdentityString : 
        system : PISystem * 
        userIdentity : ClaimsIdentity -> string

Parameters

system: Type: OSIsoft.AFPISystem
The PISystem to obtain the security identity string for the specified userIdentity.
userIdentity: Type: System.Security.ClaimsClaimsIdentity
The ClaimsIdentity of the user for the security identity string to be returned.

Return Value

Type: String
The returned string includes the name of the specified userIdentity along with the list of security identities for that user within parentheses and separated by a vertical bar.

Remarks

This method will return a string representation of the specified user identity along with that user's associated security identities enclosed within parentheses.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0

AF SDK Reference