| 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.
|
| Modifier and Type | Field and Description |
|---|---|
static AuthnErrorDetailSpec |
CommonErrorDetailSpec.ACCOUNT_RECOVERY_ERROR
The error detail returned when an account recovery error is encountered.
|
static AuthnErrorDetailSpec |
CommonErrorDetailSpec.CAPTCHA_ERROR
The error detail returned when an re-captcha error is encountered.
|
static AuthnErrorDetailSpec |
CommonErrorDetailSpec.CREDENTIAL_VALIDATION_FAILED
The error detail returned when invalid credentials were provided for a user.
|
static AuthnErrorDetailSpec |
CommonErrorDetailSpec.FIELD_REQUIRED
The error detail returned when a required field is missing from an authentication API POST request
|
static AuthnErrorDetailSpec |
CommonErrorDetailSpec.INVALID_CHALLENGE_RESPONSE
The error detail returned when invalid challenge response were provided for a user.
|
static AuthnErrorDetailSpec |
CommonErrorDetailSpec.INVALID_CONTENT_TYPE
The error detail returned when the content type format of an authentication API POST request is invalid.
|
static AuthnErrorDetailSpec |
CommonErrorDetailSpec.INVALID_FIELD_FORMAT
The error detail returned when the format of a field is missing from an authentication API POST request.
|
static AuthnErrorDetailSpec |
CommonErrorDetailSpec.PASSWORD_CHANGE_ERROR
The error detail returned when an password change error is encountered.
|
static AuthnErrorDetailSpec |
CommonErrorDetailSpec.UNEXPECTED_ACTION_MODEL
The error detail returned when an unexpected action model is provided when none is expected for an authentication API POST request
|
static AuthnErrorDetailSpec |
CommonErrorDetailSpec.UNRECOGNIZED_FIELD_NAME
The error detail returned when an unrecognized field is encountered in an authentication API POST request.
|
| Modifier and Type | Method and Description |
|---|---|
AuthnErrorDetailSpec |
AuthnErrorDetailSpec.Builder.build()
Build the spec.
|
| Modifier and Type | Method and Description |
|---|---|
List<AuthnErrorDetailSpec> |
AuthnErrorGroup.getErrorDetails()
Get the specs for error details that may be included with the top-level error.
|
| Modifier and Type | Method and Description |
|---|---|
AuthnErrorGroup.Builder |
AuthnErrorGroup.Builder.errorDetail(AuthnErrorDetailSpec detailSpec)
Add an error detail spec to the list.
|
AuthnActionSpec.Builder<ModelType> |
AuthnActionSpec.Builder.errorDetail(AuthnErrorDetailSpec errorDetailSpec)
Add an error detail spec.
|
| Modifier and Type | Method and Description |
|---|---|
AuthnActionSpec.Builder<ModelType> |
AuthnActionSpec.Builder.errorDetails(Collection<AuthnErrorDetailSpec> details)
Add a collection of error detail specs.
|
Copyright 2019 Ping Identity Corp. All rights reserved.