Fetching Key Names

If the client application is connected to the server via a global session, only global keys can be fetched, whereas, if it is connected to the server via an authenticated session, you can fetch:

• all global keys

• all keys owned by the user

• all keys available to groups, the user is associated with

Fetching all key names

To fetch list of key names that are accessible to the user.

Call the GetKeyNames method from the NaeKeyManagement class.

NaeKeyManagement nkm = new NaeKeyManagement(session);
string[] keyNames = nkm.GetKeyName();
Console.WriteLine("Keynames : ");
if (keyNames.Length != 0)
{
    foreach (string keyName in keyNames)
    {
        Console.WriteLine(keyName);
    }
}

Sample Output

Keynames :
test_user_1_key
test_getKeyNames_global_key
test_user_1_key3
test_user_1_key2
test_user_1_key1

The above code displays the list of all key names.

Fetching key names using multiple attributes

You can also filter out the result using custom attributes as search criteria. The NaeKeyNameAttr class is used to set the search criteria.

The below table describes the list of input parameters that can be used as a search criteria.

To fetch key names using multiple attributes:

1. Create a list of custom attributes by creating multiple instances of the NaeCustomAttr class.

   NaeCustomAttr customAttribute1 = new NaeCustomAttr();
   customAttribute1.attrKey = "x-CustomAttributeName";
   customAttribute1.attrValue = "X-VAlue";
   
   NaeCustomAttr customAttribute2 = new NaeCustomAttr();
   customAttribute2.attrKey = "Y-CustomAttributeName";
   customAttribute2.attrValue = "Y-Value";
   
   List<NaeCustomAttr> lst = new List<NaeCustomAttr>();
   lst.Add(customAttribute1);
   lst.Add(customAttribute2);
   

2. Create an instance of the NaeKeyNameAttr class and set the conjunctive operators, custom attributes, max keys, key offset, and finger print parameters.

   NaeKeyNameAttr attr = new NaeKeyNameAttr();
   attr.ConjunctiveOpr = NaeKeyNameAttr.ConjunctiveOperator.OR;
   attr.CustomAttributes = lst;
   attr.maxKeys = 10;
   attr.keyOffset = 0;
   attr.fingerprint = "";
   

3. Call the GetKeyNames method from the NaeKeyManagement class and pass the instance of the NaeKeyNameAttr class as a parameter. The return type of the GetKeyNames method is string[].

   nkm = new NaeKeyManagement(session);
   string[] keyNames = nkm.GetKeyNames(attr);
   Console.WriteLine("Keynames : ");
   if (keyNames.Length != 0)
   {
       foreach (string keyName in keyNames)
       {
           Console.WriteLine(keyName);
       }
   }
   

   Sample Output

   Keynames :
   test_user_1_key
   test_getKeyNames_global_key
   test_user_1_key3
   test_user_1_key2
   test_user_1_key1
   

4. Get the Total Key Count and Key Count using the NaeKeyNameAttr instance.

   Console.WriteLine("TotalKeyCount = " + attr.totalKeyCount);
   Console.WriteLine("KeyCount = " + attr.keyCount);
   

   Sample Output

   TotalKeyCount = 9
   KeyCount = 3