Scripting and Programming Guides › Developer's Guide for Java › Java API Overview › Java API Flow › Obtain a Session › Log in as a SiteMinder Administrator

Log in as a SiteMinder Administrator

To authenticate a SiteMinder administrator, use the login() method in the SmApiSession class of the Utilities package. This method uses the administrator’s login credentials (username and password) to authenticate the administrator. Calling this login() method obtains a session specification and returns an SmApiResult object.

The syntax of the login() method is as follows:

result=mySession.login (username,
                        password,
                        IPaddress,
                        challengeReason);

Provide a value for the challengeReason parameter as follows:

• On the administrator’s initial login, set challengeReason to 0 (no reason).
• If the initial login fails, use challengeReason in the next login() call to specify the results of the previous authentication attempt.

  To retrieve the reason value to assign to challengeReason, call getReason() in the SmApiResult object.

To obtain a new session specification for a user, use the Java Agent API to obtain a session specification. Then, create an SmApiSession object and associate the session specification with that object.