An administrator can use UserAPI to allow Java applications to integrate with the SecureLogin single sign-on data. The UserAPI class can perform the following actions.
Validating the passphrase answer against the passphrase question
Provisioning the user credentials
A UserAPI instance is created using the SchlAPI interface. The SchlAPI interface defines how the UserAPI and supporting classes connect to the directory and SchlAPI license key. Once the UserAPI instance is created, attach it to a user object by directory DN before you invoke other methods. For example:
UserAPI api = new UserAPI(new MyConfig());api.attach("cn=myname,cn=users,dc=protocom,dc=com");String question = api.getQuestion();
The following table includes the constructor details to create an UserAPI instance.
|
Constructor |
Description |
|---|---|
|
UserAPI(SchlapiConfig config) |
Creates an UserAPI instance. |
The UserAPI instances are not locked to an object after attach in invoked. To access another LDAP object, invoke attach with that object's DN.
The following table explains the methods and modifiers to use with UserAPI.
|
Modifier and Type |
Method and Description |
|---|---|
|
boolean |
attach(String object) Attaches this instance to an LDAP object. |
|
void |
close() This is not part of attach but must be invoked when you no longer need the UserAPI instance so that LDAP connections can be closed. |
|
void |
deprovisionAccount(String account) Removes an account from the directory. |
|
string |
getQuestion() Displays the SecureLogin single sign-on passphrase question. |
|
void |
provisionAccount(String account, Map credentials, String description) Creates an account and provisions credentials. |
|
void |
provisionLinks(String platform, String credId, String isSetPlat) Links credentials to a specific application. |
|
void |
provisionPassphraseQA(String password, String question, String answer) Provisions an account with a new passphrase question and answer. |
|
void |
removeNonRepudiation(String password, String answer) Re-encrypts the user's entries using the new Windows password. |
|
boolean |
verifyAnswer(String answer) Indicates if the answer to the SecureLogin single sign-on question is correct. |