AF SDK Reference

AFSecurity.RemoveIdentity Method (PISystem, AFSecurityIdentity)

Save PDF

TABLE OF CONTENTS

AFSecurity.RemoveIdentity Method (PISystem, AFSecurityIdentity)

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Remove all security rights for an AFSecurityIdentity from all objects in the PISystem.

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

Syntax

public static void RemoveIdentity(
	PISystem system,
	AFSecurityIdentity identity
)

Public Shared Sub RemoveIdentity ( 
	system As PISystem,
	identity As AFSecurityIdentity
)

Dim system As PISystem
Dim identity As AFSecurityIdentity

AFSecurity.RemoveIdentity(system, identity)

public:
static void RemoveIdentity(
	PISystem^ system, 
	AFSecurityIdentity^ identity
)

static member RemoveIdentity : 
        system : PISystem * 
        identity : AFSecurityIdentity -> unit

Parameters

system: Type: OSIsoft.AFPISystem
The PISystem containing the objects to be modified.
identity: Type: OSIsoft.AFAFSecurityIdentity
The AFSecurityIdentity to be removed from the objects.

Remarks

This method will remove all the access and deny security rights for the security identity from every object in the PI AF Server associated with the PISystem.

Important
Since the AddIdentity Overload method can modify existing security settings, this method cannot restore the objects to their original security settings.

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