Package com.pingidentity.sdk.api.authn.spec

Class AuthnErrorGroup

java.lang.Object

com.pingidentity.sdk.api.authn.spec.AuthnErrorGroup

public class AuthnErrorGroup
extends Object

A class that describes a group of errors returned by the Authentication API. This includes the spec of the top-level error, as well as the specs for a list of error details that may be included with that error. This class is used by PingFederate in generating API documentation.

Since:

9.3

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthnErrorGroup.Builder	A fluent builder for AuthnErrorGroup instances.

Method Summary

Modifier and Type	Method	Description
AuthnErrorSpec	getError()	Get the spec for the top-level error.
List<AuthnErrorDetailSpec>	getErrorDetails()	Get the specs for error details that may be included with the top-level error.

Methods inherited from class java.lang.Object

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

Method Details

getError

public AuthnErrorSpec getError()

Get the spec for the top-level error.

getErrorDetails

public List<AuthnErrorDetailSpec> getErrorDetails()

Get the specs for error details that may be included with the top-level error.