Package | Description |
---|---|
com.pingidentity.sdk.api.authn.common |
Contains "spec" classes for states, actions, and errors that are shared across multiple API-capable plugins.
|
com.pingidentity.sdk.api.authn.spec |
Defines various "spec" classes for the Authentication API.
|
com.pingidentity.sdk.api.authn.util |
Defines various utility classes for handling Authentication API requests and generating responses.
|
Modifier and Type | Field and Description |
---|---|
static AuthnStateSpec<OneTimeLinkVerificationRequired> |
CommonStateSpec.ACCOUNT_RECOVERY_OTL_VERIFICATION_REQUIRED
A state where one-time link user verification is required for account recovery to proceed.
|
static AuthnStateSpec<AccountRecoveryUsernameRequired> |
CommonStateSpec.ACCOUNT_RECOVERY_USERNAME_REQUIRED
A state where a username is required for account recovery to proceed.
|
static AuthnStateSpec<Canceled> |
CommonStateSpec.CANCELED
The state where an authentication API action is canceled.
|
static AuthnStateSpec<ChallengeResponseRequired> |
CommonStateSpec.CHALLENGE_RESPONSE_REQUIRED
A state where the user must enter a challenge response to proceed.
|
static AuthnStateSpec<Completed> |
CommonStateSpec.COMPLETED
The state where an authentication API action is complete.
|
static AuthnStateSpec<AuthenticationFailed> |
CommonStateSpec.FAILED
A state indicating that an error occurred that terminated the authentication flow.
|
static AuthnStateSpec<NewPasswordRequired> |
CommonStateSpec.MUST_CHANGE_PASSWORD
A state where the user's existing password is expired and must be changed.
|
static AuthnStateSpec<NewPasswordRecommended> |
CommonStateSpec.NEW_PASSWORD_RECOMMENDED
A state where the user's existing password is about to expire, and password change is recommended.
|
static AuthnStateSpec<NewPasswordRequired> |
CommonStateSpec.NEW_PASSWORD_REQUIRED
A state where a new password is required to proceed.
|
static AuthnStateSpec<PasswordResetRequired> |
CommonStateSpec.PASSWORD_RESET_REQUIRED
A state where a new password is required to complete password reset.
|
static AuthnStateSpec<RecoveryCodeRequired> |
CommonStateSpec.RECOVERY_CODE_REQUIRED
A state where a recovery pass code is required for account recovery to proceed.
|
static AuthnStateSpec<Resume> |
CommonStateSpec.RESUME
The state where the API client must redirect to PingFederate for processing to continue.
|
static AuthnStateSpec<SuccessfulAccountUnlock> |
CommonStateSpec.SUCCESSFUL_ACCOUNT_UNLOCK
A state where the user has successfully complete an account unlock.
|
static AuthnStateSpec<SuccessfulPasswordChange> |
CommonStateSpec.SUCCESSFUL_PASSWORD_CHANGE
A state where the user has successfully completed a password change.
|
static AuthnStateSpec<SuccessfulPasswordReset> |
CommonStateSpec.SUCCESSFUL_PASSWORD_RESET
A state where the user has successfully completed a password reset.
|
static AuthnStateSpec<UsernamePasswordRequired> |
CommonStateSpec.USERNAME_PASSWORD_REQUIRED
A state where the user must enter their username and password to proceed.
|
static AuthnStateSpec<UsernameRecoveryEmailRequired> |
CommonStateSpec.USERNAME_RECOVERY_EMAIL_REQUIRED
The status indicating that the user must enter their email to proceed.
|
static AuthnStateSpec<UsernameRecoveryEmailSent> |
CommonStateSpec.USERNAME_RECOVERY_EMAIL_SENT
The status indicating that an email containing the user's username has be sent.
|
Modifier and Type | Method and Description |
---|---|
AuthnStateSpec<ModelType> |
AuthnStateSpec.Builder.build()
Build the spec.
|
Modifier and Type | Method and Description |
---|---|
List<AuthnStateSpec<?>> |
PluginApiSpec.getStates()
Get the states available in the plugin's API.
|
Modifier and Type | Method and Description |
---|---|
AuthnStateSpec.Builder<ModelType> |
AuthnStateSpec.Builder.template(AuthnStateSpec<?> template,
Class<ModelType> overrideModelClass)
Initialize the builder with the values from an existing spec, overriding the model class.
|
AuthnStateSpec.Builder<ModelType> |
AuthnStateSpec.Builder.template(AuthnStateSpec<ModelType> template)
Initialize the builder with the values from an existing spec.
|
Modifier and Type | Method and Description |
---|---|
void |
PluginApiSpec.setStates(List<AuthnStateSpec<?>> states)
Set the states available in the plugin's API.
|
Constructor and Description |
---|
PluginApiSpec(List<AuthnStateSpec<?>> states)
Create an instance based on the specified parameters.
|
Modifier and Type | Method and Description |
---|---|
<ModelType> |
AuthnApiSupport.makeAuthnState(javax.servlet.http.HttpServletRequest request,
AuthnStateSpec<ModelType> stateSpec,
ModelType stateModel)
Create an
AuthnState instance based on an
AuthnStateSpec instance. |
Copyright 2019 Ping Identity Corp. All rights reserved.