AFSecurityMappings Class
- Last UpdatedNov 18, 2025
- 8 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFSecurityMappings collection represents the available
AFSecurityMapping objects on a particular PISystem
(PI AF Server).

Inheritance Hierarchy
SystemObject
OSIsoft.AFAFCollection
OSIsoft.AFAFCollectionAFSecurityMapping
OSIsoft.AFAFNamedCollectionAFSecurityMapping
OSIsoft.AFAFSecurityMappings
OSIsoft.AFAFCollection
OSIsoft.AFAFCollectionAFSecurityMapping
OSIsoft.AFAFNamedCollectionAFSecurityMapping
OSIsoft.AFAFSecurityMappings
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public class AFSecurityMappings : AFNamedCollection<AFSecurityMapping>
Public Class AFSecurityMappings Inherits AFNamedCollection(Of AFSecurityMapping) Dim instance As AFSecurityMappings
public ref class AFSecurityMappings : public AFNamedCollection<AFSecurityMapping^>
type AFSecurityMappings = class inherit AFNamedCollection<AFSecurityMapping> end
The AFSecurityMappings type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| Count |
Gets the number of items actually contained in the collection.
(Inherited from AFCollectionT.) | |
| Identity |
This read-only property contains identity of the object.
(Inherited from AFCollection.) | |
| IsDeleted |
This read-only property indicates whether the owner of the collection has been deleted.
(Inherited from AFCollection.) | |
| ItemGuid | Returns the item in the collection associated with the passed in ID. (Inherited from AFCollectionT.) | |
| ItemInt32 | Returns the item located at the passed in index. (Inherited from AFCollectionT.) | |
| ItemString |
Returns the specified object from the collection by name.
(Inherited from AFNamedCollectionT.) | |
| ItemIdentity |
This read-only property specifies the identity of the objects within the collection.
(Inherited from AFCollection.) | |
| PISystem |
This read-only property allows access to the PISystem
associated with this collection.
(Inherited from AFCollection.) |
Methods
| Name | Description | |
|---|---|---|
| Add(T) |
Adds an object to the end of the collection.
(Inherited from AFCollectionT.) | |
| Add(String, NTAccount, AFSecurityIdentity, String) |
The Add method creates a new AFSecurityMapping from the specified
NTAccount to a AFSecurityIdentity and adds it to the collection.
| |
| Add(String, String, AFSecurityIdentity, AFSecurityMappingType) |
The Add method creates a new AFSecurityMapping from the specified OpenId Connect
account to a AFSecurityIdentity and adds it to the collection.
| |
| Clear |
Removes all items from the collection.
(Inherited from AFCollectionT.) | |
| Contains(Guid) |
This method determines whether the collection contains a specific item referenced by id.
(Inherited from AFCollectionT.) | |
| Contains(T) |
This method determines whether the collection contains a specific item.
(Inherited from AFCollectionT.) | |
| Contains(String) |
This method determines whether the collection contains a specific item referenced by name.
(Inherited from AFNamedCollectionT.) | |
| CopyTo |
Copies the entire collection to a compatible one-dimensional Array,
starting at the specified index of the target array.
(Inherited from AFCollectionT.) | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
| GetEnumerator |
Returns an enumerator that iterates through the collection.
(Inherited from AFCollectionT.) | |
| GetHashCode |
Gets the hash code for this instance of the object which is suitable for use in hashing
algorithms and data structures like a hash table.
(Inherited from AFCollection.) | |
| GetType | Gets the Type of the current instance. (Inherited from Object.) | |
| IndexOf |
Searches for the specified object and returns the zero-based index of the first
occurrence within the entire collection.
(Inherited from AFCollectionT.) | |
| Insert |
Inserts an item into the collection at the specified index.
| |
| Refresh |
Refresh the collection to make sure it's list of items is up-to-date.
| |
| Remove(Guid) |
Removes the item with the specified id from the collection.
(Inherited from AFCollectionT.) | |
| Remove(T) |
Removes the first occurrence of a specific object from the collection.
(Inherited from AFCollectionT.) | |
| Remove(String) |
The Remove method removes the item from the collection by name.
(Inherited from AFNamedCollectionT.) | |
| RemoveAt |
Removes the item at the specified index of the collection.
(Inherited from AFCollectionT.) | |
| Sort |
Sorts the items in the entire collection using the default comparer.
(Inherited from AFCollectionT.) | |
| Sort(IComparerT) |
Sorts the items in the entire collection using the specified comparer.
(Inherited from AFCollectionT.) | |
| Sort(Int32, Int32, IComparerT) |
Sorts the items in a range of items in the collection using the specified comparer.
(Inherited from AFCollectionT.) | |
| ToString |
Returns a String that represents the current object.
(Inherited from AFCollection.) |
Remarks
This is the collection of available AFSecurityMapping objects
on a particular PISystem (PI AF Server). Each AFSecurityMapping
object provides the mapping from Windows user or group to a AFSecurityIdentity
on the PI AF Server.
Examples
// This example shows how to create and configure Security Identities // and Security Mappings. // Get the PISystem PISystems myPISystems = new PISystems(); PISystem myPISystem = myPISystems.DefaultPISystem; // Add a new Security Identity AFSecurityIdentity myIdentity = myPISystem.SecurityIdentities.Add("MyTestUser"); myIdentity.Description = "Test User Identity"; myIdentity.CheckIn(); // Add a new Security Mapping for current user to the new Security Identity AFSecurityMapping myMapping1 = myPISystem.SecurityMappings.Add(null, null, myIdentity); myMapping1.Description = "Current User Mapping"; // Add a new Security Mapping for a different account to the new Security Identity NTAccount account = new NTAccount(@"Guest"); AFSecurityMapping myMapping2 = myPISystem.SecurityMappings.Add("MyGuest", account, myIdentity); myMapping2.Description = "My Guest Mapping"; myPISystem.CheckIn(); // Display each Security Mapping int securityMappingCount = myPISystem.SecurityMappings.Count; Console.WriteLine("Security Mapping Count = {0}", securityMappingCount); foreach (AFSecurityMapping CurMapping in myPISystem.SecurityMappings) { Console.WriteLine(" Name = {0}", CurMapping.Name); Console.WriteLine(" Description = {0}", CurMapping.Description); Console.WriteLine(" Account = {0}", CurMapping.Account); } // Display each Security Identity int securityIdentityCount = myPISystem.SecurityIdentities.Count; Console.WriteLine("Security Identity Count = {0}", securityIdentityCount); foreach (AFSecurityIdentity CurIdentity in myPISystem.SecurityIdentities) { Console.WriteLine(" Name = {0}", CurIdentity.Name); Console.WriteLine(" Description = {0}", CurIdentity.Description); } // Remove the new Security Identity which will remove the new Security Mappings. myPISystem.SecurityIdentities.Remove(myIdentity); myPISystem.CheckIn();
' This example shows how to create and configure Security Identities ' and Security Mappings. ' Get the PISystem Dim myPISystems As New PISystems() Dim myPISystem As PISystem = myPISystems.DefaultPISystem ' Add a new Security Identity Dim myIdentity As AFSecurityIdentity = myPISystem.SecurityIdentities.Add("MyTestUser") myIdentity.Description = "Test User Identity" myIdentity.CheckIn() ' Add a new Security Mapping for current user to the new Security Identity Dim myMapping1 As AFSecurityMapping = myPISystem.SecurityMappings.Add(Nothing, Nothing, myIdentity) myMapping1.Description = "Current User Mapping" ' Add a new Security Mapping for a different account to the new Security Identity Dim account As New NTAccount("Guest") Dim myMapping2 As AFSecurityMapping = myPISystem.SecurityMappings.Add("MyGuest", account, myIdentity) myMapping2.Description = "My Guest Mapping" myPISystem.CheckIn() ' Display each Security Mapping Dim securityMappingCount As Integer = myPISystem.SecurityMappings.Count Console.WriteLine("Security Mapping Count = {0}", securityMappingCount) For Each CurMapping As AFSecurityMapping In myPISystem.SecurityMappings Console.WriteLine(" Name = {0}", CurMapping.Name) Console.WriteLine(" Description = {0}", CurMapping.Description) Console.WriteLine(" Account = {0}", CurMapping.Account) Next ' Display each Security Identity Dim securityIdentityCount As Integer = myPISystem.SecurityIdentities.Count Console.WriteLine("Security Identity Count = {0}", securityIdentityCount) For Each CurIdentity As AFSecurityIdentity In myPISystem.SecurityIdentities Console.WriteLine(" Name = {0}", CurIdentity.Name) Console.WriteLine(" Description = {0}", CurIdentity.Description) Next ' Remove the new Security Identity which will remove the new Security Mappings. myPISystem.SecurityIdentities.Remove(myIdentity) myPISystem.CheckIn()
No code example is currently available or this language may not be supported.
No code example is currently available or this language may not be supported.