.NET API Reference for Oracle Identity Connector Framework 11.1.2
E41516-01
Assembly: Framework (in Framework.dll) Version: 1.4.0.0 (1.4.0.0)
E41516-01
Simple authentication with two parameters presumed to be user name and
password.
Namespace: Org.IdentityConnectors.Framework.Spi.OperationsAssembly: Framework (in Framework.dll) Version: 1.4.0.0 (1.4.0.0)
Syntax
C# |
---|
Uid Authenticate( ObjectClass objectClass, string username, GuardedString password, OperationOptions options ) |
Parameters
- objectClass
- Type: Org.IdentityConnectors.Framework.Common.Objects..::..ObjectClass
- username
- Type: System..::..String
the name based credential for authentication.
- password
- Type: GuardedString
the password based credential for authentication.
Return Value
Type: Uid
Remarks
The 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 InvalidPasswordException.
Exceptions
Exception | Condition |
---|---|
System..::..Exception | iff native authentication fails. If a native exception if available attempt to throw it. |