Contact Management Methods

This article contains the following topics:
casm173
This article contains the following topics:
This section explains the Web Services Contact Management methods.
login
The following parameters apply to the login method:
Parameter
Type
Description
username
String
Identifies the user ID.
password
String
Identifies the password.
Description
Login validates a user with CA SDM login validation and returns a unique session ID that is required for most other web method calls. This key should be freed with logout(). A SID may expire if it is not used before a time out elapses.
The username/password is validated exactly the same as the CA SDM Web client; the contact’s Access Type specifies the validation method. The default access policy will be applied to control and manage all subsequent accesses after a successful call of this function. The login user (not proxy contact specified in the default policy) is then responsible for subsequent web service activities. All function group security and data partition are enforced for the login user.
Returns
The following is returned:
Parameter
Type
Description
<SID>
Integer
Identifies the unique SID to use for all other Web Services calls.
loginService
The following parameters apply to the loginService method:
Parameter
Type
Description
username
String
Identifies the user ID.
password
String
Identifies the password.
policy
String
(Required) Identifies the policy code, which must be in plain text. Although it is required, it may be empty.
Description
Lets users log in with a conventional username/password authentication scheme where if valid, the system returns a unique session ID. This key should be freed with logout(). A SID may expire if it is not used before a timeout elapses.
User authentication is performed on the username and password while access control is applied based on the policy specified. The authentication is performed as described in login(). Empty policy will allow default policy to be applied automatically. The login user (not the proxy contact specified in the policy) is responsible for subsequent web service activities. All function group security and data partitions are enforced for the login user.
Returns
The following is returned:
Parameter
Type
Description
SID
Integer
Specifies the unique SID to use for all other Web Services calls.
impersonate
The following parameters apply to the impersonate method:
Parameter
Type
Description
SID
Integer
Identifies the session retrieved from logging in.
username
String
(Required) Identifies the user name of the user being impersonated.
Description
Lets an administrator switch the user responsible for all web services activities in a current web services session without additional user authentication. Invoking this method is allowed only if the current web services session is started by using the PKI access authentication scheme and the access policy is defined to allow impersonation.
The Access Type of the user to be impersonated is checked against the Access Type of the proxy user of the policy used in the current web services session. If the access_level of the new user’s access type is less than or equal to the grant_level of the proxy user’s access type, this method will replace the current user with the new user. A new web services session starts while the old session ends. A new
SID is then returned. In addition, the new user is given the responsibility for all subsequent activities initiated in this new session. The function group security and data partition are enforced for the new user.
Returns
The following is returned:
Parameter
Type
Description
SID
Integer
Identifies the unique SID to use for all other Web Services calls.
logout
The following parameter applies to the logout method:
Parameter
Type
Description
SID
Integer
Identifies the session retrieved from logging in.
Description
Invalidates a SID obtained from login(), loginService(), and loginServiceManaged().
Returns
Nothing.
loginWithArtifact
The following parameters apply to the loginWithArtifact method:
Parameter
Type
Description
userid
String
Identifies the user ID.
artifact
String
Identifies the Artifact obtained from CA EEM.
Description
Performs the user authentication by the provided CA EEM Artifact and opens a session with the back-end server. The Artifact can be used only once for authentication. The returned session ID (SID) can be used for subsequent web services method invocations. The Artifact can be acquired directly from CA EEM or can be obtained by the getArtifact method.
Service Desk needs to be integrated with CA EEM to perform this operation.
The SID should be freed with logout(). A SID may expire if it is not used before a timeout elapses.
Returns
The following is returned:
Parameter
Type
Description
SID
String
Identifies the unique session ID (SID) to use for all other Web Services calls. It is in plain text format.