SpiraPlan: SoapService SOAP Web Service

See all operations

Connection_Authenticate2

Description

Authenticates against the server. Need to call before using other methods. This overload allows you to use the same API Key / RSS Token as the REST Service

Also checks to make sure they have enough connection licenses

Example(s)

            RemoteCredentials credentials = Connection_Authenticate2("fredbloggs", "{03D4B256-C10F-4BAC-86F7-10E817C9CC84}", "My Integration App 1");
            if (credentials == null) { MessageBox.Show("Incorrect login/api key"); }
            else { MessageBox.Show("You have logged in as User ID: " + credentials.UserId); }
            

Parameters

Type Name Required
string? userName - The username of the user
string? apiKey - The user's API Key / RSS Token
string? plugInName - The name of the plug-in

Return Value

RemoteCredentials - The credentials object if successful, NULL if not