Package com.pingidentity.sdk.captchaprovider

Class CaptchaProvider.AuthenticationStatus

java.lang.Object

com.pingidentity.sdk.captchaprovider.CaptchaProvider.AuthenticationStatus

Enclosing interface:

CaptchaProvider

public static final class CaptchaProvider.AuthenticationStatus
extends Object

A readonly representation of the current authentication status

Since:

11.3

Field Summary

Fields

Modifier and Type	Field	Description
final AuthnAdapterResponse	authnAdapterResponse

Constructor Summary

Constructors

Constructor	Description
AuthenticationStatus(AuthnAdapterResponse authnAdapterResponse)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getAttributeMap()	Get a Readonly map of attributes that uniquely identify the authenticated security context of the user.
AuthnAdapterResponse.AUTHN_STATUS	getAuthnStatus()	Get the status of an authentication returned from an IdP adapter.
int	getErrorCode()	Get error code.
String	getErrorMessage()	Get an error message.
String	getUsername()	Get the username that has been authenticated or attempted.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

authnAdapterResponse

public final AuthnAdapterResponse authnAdapterResponse

Constructor Details

AuthenticationStatus

public AuthenticationStatus(AuthnAdapterResponse authnAdapterResponse)

Method Details

getAuthnStatus

public AuthnAdapterResponse.AUTHN_STATUS getAuthnStatus()

Get the status of an authentication returned from an IdP adapter.

Returns:

authentication status

Since:

11.3

getAttributeMap

public Map<String,Object> getAttributeMap()

Get a Readonly map of attributes that uniquely identify the authenticated security context of the user. refer to AuthnAdapterResponse.getAttributeMap() for more details.

Returns:

a map of attributes

Since:

11.3

getErrorCode

public int getErrorCode()

Get error code.

Returns:

error code

Since:

11.3

getUsername

public String getUsername()

Get the username that has been authenticated or attempted.

Returns:

username

Since:

11.3

getErrorMessage

public String getErrorMessage()

Get an error message. The message may be logged in audit log.

Returns:

error message

Since:

11.3