org.identityconnectors.framework.api.operations
Interface AuthenticationApiOp
- All Superinterfaces:
- APIOperation
- All Known Subinterfaces:
- ConnectorFacade
public interface AuthenticationApiOp
- extends APIOperation
authenticate
Uid authenticate(ObjectClass objectClass,
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:
RuntimeException
- iff the credentials do not pass authentication otherwise
nothing.
Copyright © 2012. All Rights Reserved.