API Programming Guide › API Authentication › API Login

API Login

This call authenticates a user using a set of CA EEM credentials, a certificate, or a session ID.

Because you can include authentication information in any API call URL, you do not need a separate login call in most cases. The login call is most useful for returning a Session ID, which can then be used to authenticate another call, such as getReportViewer.

The arguments used for this call are as follows:

• username

  Defines the valid CA Enterprise Log Manager user name for authentication.

• certname

  Defines the certificate name for authentication, if you have registered the product you want to access CA Enterprise Log Manager.

• password

  Defines either the CA Enterprise Log Manager user password, or the certificate password for authentication, depending on which method you have used for authentication.

• sessionid

  Defines the session ID from an existing authenticated session, which you can use to authenticate a new session.

API Login Examples

Command:

https://ELMSERVER:5250/spin/calmapi/calmapi_login.csp&username=xx&password=xx

Success Response:

  <?xml version="1.0" encoding="UTF-8" ?> 
 <Result>
  <Value>true</Value> 
  <Description>Authentication Successful.</Description>
  <SessionId>spin=62e39751-computername.domain.com49b8a97e-9bfd318-1</SessionId> 
  </Result>

The session ID opened by the login appears in the <SessionId> tag.

Failure Response:

<?xml version="1.0" encoding="UTF-8" ?> 
<Result>
<Value>false</Value>
	<Description> EE_AUTHFAILED Authentication Failed</Description>
</Result>