Previous Topic: SmAuthScheme Methods

Next Topic: How SiteMinder Loads a Custom Authentication Scheme

Other Classes in the Authentication API

The following classes are used in conjunction with the SmAuthScheme base interface:

Class

Description

SmAuthenticationContext

Contains the following context classes passed to authenticate():

APIContext

UserContext

UserCredentialsContext

The set... methods in this object pass information directly to SiteMinder.

SmAuthenticationResult

Contains status and reason codes returned to SiteMinder after a call to authenticate().

SmAuthQueryCode

Contains the type of request that SiteMinder is making of the authentication scheme (version number and description, or information about the credentials that SiteMinder must collect).

SiteMinder passes this object to the authentication scheme in query().

SmAuthQueryResponse

Contains constants that specify the kind of credentials that are required for authentication, if any. Also allows a text message to be returned to SiteMinder for display to the user.

Optionally, the authentication scheme can call setResponseBuffer() to specify a URL where credentials must be collected.

The set... methods in this object pass information directly to SiteMinder.

SmAuthStatus

Contains Authentication API status codes such as SMAUTH_ACCEPT and SMAUTH_REJECT.

This object can be passed back to SiteMinder in SmAuthenticationResult. It is also the return value type for the authentication scheme’s init(), query(), and release() methods.

UserCredentialsContext

Contains credentials information and other information from the user directory where user context was established.

This object is contained in the SmAuthenticationContext object passed to authenticate().