Skip navigation links

org.identityconnectors.framework.api.operations
Interface AuthenticationApiOp

All Superinterfaces:

APIOperation

All Known Subinterfaces:

ConnectorFacade

public interface AuthenticationApiOp

extends APIOperation

Log in to a target system or application (using a specified username and password).

Field Summary

Fields inherited from interface org.identityconnectors.framework.api.operations.APIOperation

NO_TIMEOUT

Method Summary

Uid	authenticate(ObjectClass objectClass, java.lang.String username, GuardedString password, OperationOptions options) Most basic authentication available.

Method Detail

authenticate

Uid authenticate(ObjectClass objectClass,
                 java.lang.String username,
                 GuardedString password,
                 OperationOptions options)

Most basic authentication available.

Parameters:

objectClass - The object class to use for authenticate. Will typically be an account. Must not be null.

username - string that represents the account or user id.

password - string that represents the password for the account or user.

options - additional options that impact the way this operation is run. May be null.

Returns:

Uid The uid of the account that was used to authenticate

Throws:

java.lang.RuntimeException - iff the credentials do not pass authentication otherwise nothing.

Skip navigation links