Org.IdentityConnectors.Framework.Spi.Operations.AuthenticateOp Interface Reference

Authenticate an object based on their unique identifier and password. More...

Inherits Org.IdentityConnectors.Framework.Spi.Operations.SPIOperation.

Public Member Functions
Uid	Authenticate (ObjectClass objectClass, String username, GuardedString password, OperationOptions options)
	Simple authentication with two parameters presumed to be user name and password. More...

Detailed Description

Authenticate an object based on their unique identifier and password.

Member Function Documentation

Uid Org.IdentityConnectors.Framework.Spi.Operations.AuthenticateOp.Authenticate	(	ObjectClass	objectClass,
		String	username,
		GuardedString	password,
		OperationOptions	options
	)

Simple authentication with two parameters presumed to be user name and password.

The Org.IdentityConnectors.Framework.Spi.Connector developer is expected to attempt to authenticate these credentials natively. If the authentication fails the developer should throw a type of Exception either ArgumentException or if a native exception is available and if its of type Exception simple throw it. If the native exception is not a Exception wrap it in one and throw it. This will provide the most detail for logging problem and failed attempts.

The developer is of course encourage to try and throw the most informative exception as possible. In that regards there are several exceptions provided in the exceptions package. For instance one of the most common is Org.IdentityConnectors.Framework.Common.Exceptions.InvalidPasswordException.

Parameters

username	the name based credential for authentication.
password	the password based credential for authentication.

Exceptions

Exception

iff native authentication fails. If a native exception if available attempt to throw it.

---

The documentation for this interface was generated from the following file:

• C:/ADE/icfbuild_docgen/icf/framework/.ade_path/dotnet/Framework/SpiOperations.cs