login() method of SM6.0 Java API (Legacy_Onyx KB Id: 217571)

Products

• CA Single Sign On Secure Proxy Server (SiteMinder)
• CA Single Sign On SOA Security Manager (SiteMinder)
• CA Single Sign-On

Issue/Introduction

Description:

SM6.0 Java API has a following method.

public SmApiResult login(java.lang.String username,
java.lang.String password,
java.net.InetAddress address,
int challengeReason)

I'd like to know what the "address" parameter is used for.

Thank you in advance.

Solution:

This login method is for SiteMinder administrators. For login of other users (end users as well as DMS organization administrators and DMS super administrators), see login() in class AgentAPI of the Agent API.
The parameter java.net.InetAddress address, is used to identify the machine where the administrator is logging in.

Meaning if you are running the above method in your machine, this ip will be the ip of your machine. The administrator machine ip running the codes.

To get more information please refer to the javadocs, look for the class SmApiSession and the method login.

Environment

Release:
Component: SMSDK