.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)
Uid The uid of the account that would be authenticated.
E41516-01
This is a companion to the simple AuthenticateOp 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 ResolveUsername( ObjectClass objectClass, string username, OperationOptions options ) |
Parameters
- objectClass
- Type: Org.IdentityConnectors.Framework.Common.Objects..::..ObjectClass
The object class to use for authenticate. Will typically be an account. Will not be null.
- username
- Type: System..::..String
the username that would be authenticated. Will not be null.
- options
- Type: Org.IdentityConnectors.Framework.Common.Objects..::..OperationOptions
additional options that impact the way this operation is run. If the caller passes null, the framework will convert this into an empty set of options, so SPI need not worry about this ever being null.
Return Value
Type: UidUid The uid of the account that would be authenticated.
Remarks
The difference is that this
method does not try to authenticate the credentials; instead, it
return the Uid of the username that would be authenticated.
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 is available attempt to throw it. |