| IQMSGetQVWSAuthentication Method |
Gets the authentication type for the QlikView WebServer (QVWS).
Namespace: PIX.Services.V12
Assembly:
SyntaxParameters
- qvwsID
- Type: SystemGuid
The ID of the QVWS
Return Value
Type: QVWSAuthenticationQVWS authentication.
Remarks Security Note |
|---|
Requires membership of local group QlikView Management API and the role Document Folder Administrator. |
Examples
The following code example uses the QMS API to get the current authentication type for the specified QVWS.
It changes the authentication type to NTLM and then saves it. If everything goes well, it prints the original authentication type and then a message when it's done.
If anything goes wrong it prints an error message.
The service key injection is assumed to be handled behind the scenes. For an example of how to inject the service key, see Samples.
C#
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(); ********************************************************************************************* //get a list of all QVWSs ServiceInfo[] webServers = apiClient.GetServices(ServiceTypes.QlikViewWebServer); //get the current authentication type for the first QVWS in the list QVWSAuthentication authentication = apiClient.GetQVWSAuthentication(webServers[0].ID); //set the authentication type to NTLM authentication.AuthenticationType = QVWSAuthenticationType1.Ntlm; apiClient.SetQVWSAuthentication(webServers[0].ID, authentication); Console.WriteLine("Authentication type set to NTLM."); } catch(Exception e) { Console.WriteLine("An error occured: " + e.Message); } // wait for user to press any key Console.ReadLine(); } }
See Also