Package com.pingidentity.sdk.api.authn.common

Class CommonErrorSpec

java.lang.Object

com.pingidentity.sdk.api.authn.common.CommonErrorSpec

public class CommonErrorSpec
extends Object

This class contains a set of common AuthnErrorSpec specs for use across API-capable PingFederate plugins.

Since:

9.3

Field Summary

Fields

Modifier and Type	Field	Description
static AuthnErrorSpec	INVALID_ACTION_ID	The top-level error returned when the API request is not valid for the current state of the flow.
static AuthnErrorSpec	INVALID_REQUEST	The top-level error returned when the request is invalid.
static AuthnErrorSpec	REGISTRATION_FAILED	The top-level error returned when registration fails.
static AuthnErrorSpec	REQUEST_FAILED	The top-level error returned when the request could not be completed.
static AuthnErrorSpec	RESOURCE_NOT_FOUND	The top-level error returned when the API request is for a resource that does not exist.
static AuthnErrorSpec	UNEXPECTED_ERROR	The top-level error returned when an unexpected error occurs.
static AuthnErrorSpec	VALIDATION_ERROR	The top-level error returned when one or more validation errors occurred while processing the request.

Constructor Summary

Constructors

Constructor	Description
CommonErrorSpec()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE_NOT_FOUND

public static final AuthnErrorSpec RESOURCE_NOT_FOUND

The top-level error returned when the API request is for a resource that does not exist.

Since:

9.3

INVALID_REQUEST

public static final AuthnErrorSpec INVALID_REQUEST

The top-level error returned when the request is invalid. An example would be incorrectly formatted JSON. The message can be customized by calling the instance builder's message() method.

Since:

9.3

VALIDATION_ERROR

public static final AuthnErrorSpec VALIDATION_ERROR

The top-level error returned when one or more validation errors occurred while processing the request. Additional details are provided by calling the instance builder's detail() method.

Since:

9.3

UNEXPECTED_ERROR

public static final AuthnErrorSpec UNEXPECTED_ERROR

The top-level error returned when an unexpected error occurs.

Since:

9.3

INVALID_ACTION_ID

public static final AuthnErrorSpec INVALID_ACTION_ID

The top-level error returned when the API request is not valid for the current state of the flow. The message can be customized by calling the instance builder's message() method.

Since:

9.3

REGISTRATION_FAILED

public static final AuthnErrorSpec REGISTRATION_FAILED

The top-level error returned when registration fails. This error is used when an unexpected server side error is encountered when registering the user. For example, communication to the data store failed while registering the user.

Since:

10.1

REQUEST_FAILED

public static final AuthnErrorSpec REQUEST_FAILED

The top-level error returned when the request could not be completed. Additional details are provided by calling the instance builder’s detail() method.

Since:

10.1

Constructor Detail

CommonErrorSpec

public CommonErrorSpec()