GetAvailableDSProviders Method
Overloads
GetAvailableDSProviders(Guid) |
Returns the available Directory Service Providers supported by a certain Directory Service Connector. |
GetAvailableDSProviders(Guid)
Returns the available Directory Service Providers supported by a certain Directory Service Connector.
Declaration
List<DSProvider> GetAvailableDSProviders(Guid dscID)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | dscID |
The ID of the Directory Service Connector. |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<DSProvider> |
A list of supported Directory Service Providers |
Remarks
security
Requires membership of local groups QlikView Management API and QlikView Administrator.
Examples
This example retrieves all available Directory Service providers and prints them to the screen.
The service key injection is assumed to be handled behind the scenes. For an example of how to inject the service key, see Samples.
using System;
using System.Collections.Generic;
using System.Linq;
using QMSAPI;
class Program
{
static void Main(string[] args)
{
try
{
// create a QMS API client
IQMS apiClient = new QMSClient();
//retrieve a time limited service key
ServiceKeyClientMessageInspector.ServiceKey = apiClient.GetTimeLimitedServiceKey();
ServiceInfo dscService = apiClient.GetServices(ServiceTypes.QlikViewDirectoryServiceConnector).FirstOrDefault();
if (dscService != null)
{
List<DSProvider> providers = apiClient.GetAvailableDSProviders(dscService.ID);
foreach (DSProvider provider in providers)
{
Console.WriteLine("Name:" + provider.Name);
Console.WriteLine("Type:" + provider.Type);
}
}
}
catch (Exception ex)
{
Console.WriteLine("An exception occurred: " + ex.Message);
}
// wait for user to press any key
Console.ReadLine();
}
}
Did this page help you?
If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!