Pingdom API / function Auth_login

Description

Logs the user with its credentials and provides him a session ID.

Arguments

stringAPIKey (Required)

API key. You will find your API key in the 'Pingdom API' section of Pingdom Panel.

Auth_CredentialsDatacredentialsData (Required)

Object that contains username and password used for logging in.

Return value

Auth_LoginResponseloginResponse

Response object of Auth_login function. It contains field for status of the performed operation, and field for obtained session ID.

Example request

				
<soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
	<q1:Auth_login xmlns:q1="urn:methods">
		<APIKey xsi:type="xsd:string">abcdefgh0123456789abcdefgh</APIKey>
		<credentialsData href="#id1" />
	</q1:Auth_login>
	<q2:Auth_CredentialsData id="id1" xsi:type="q2:Auth_CredentialsData" xmlns:q2="urn:PingdomAPI">
		<username xsi:type="xsd:string">username@mail.com</username>
		<password xsi:type="xsd:string">secret</password>
	</q2:Auth_CredentialsData>
</soap:Body>

Example response

				
<SOAP-ENV:Body>
	<ns1:loginResponse>
		<return xsi:type="ns2:Auth_LoginResponse">
			<status xsi:type="xsd:int">0</status>
			<sessionId xsi:type="xsd:string">91a8a34d764ad76619d3c5acb6bc63b5</sessionId>
		</return>
	</ns1:loginResponse>
</SOAP-ENV:Body>