SpiraPlan: SoapService SOAP Web Service

See all operations

Connection_Authenticate1

Description

Authenticates against the server. Need to call before using other methods. This overload allows you to specify the name of the plug-in calling the API

1) Also checks to make sure they have enough connection licenses 2) Will fallback to using the API Key if the user is OAUTH (similar to how the v5.0 API works)

Example(s)

            RemoteCredentials credentials = Connection_Authenticate1("fredbloggs", "PleaseChange", "My Integration App 1");
            if (credentials == null) { MessageBox.Show("Incorrect login/password"); }
            else { MessageBox.Show("You have logged in as User ID: " + credentials.UserId); }
            

Parameters

Type Name Required
string? userName - The username of the user
string? password - The unhashed password of the user
string? plugInName - The name of the plug-in

Return Value

RemoteCredentials - The credentials object if successful, NULL if not