
docs.RegistrationResponseError.md Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of okta-sdk-api Show documentation
Show all versions of okta-sdk-api Show documentation
The Okta Java SDK API .jar provides a Java API that your code can use to make calls to the Okta
API. This .jar is the only compile-time dependency within the Okta SDK project that your code should
depend on. Implementations of this API (implementation .jars) should be runtime dependencies only.
# RegistrationResponseError
For the registration inline hook, the `error` object provides a way of displaying an error message to the end user who is trying to register or update their profile. * If you're using the Okta Sign-In Widget for Profile Enrollment, only the `errorSummary` messages of the `errorCauses` objects that your external service returns appear as inline errors, given the following: * You don't customize the error handling behavior of the widget. * The `location` of `errorSummary` in the `errorCauses` object specifies the request object's user profile attribute. * If you don't return a value for the `errorCauses` object, and deny the user's registration attempt through the `commands` object in your response to Okta, one of the following generic messages appears to the end user: * \"Registration cannot be completed at this time.\" (SSR) * \"We found some errors. Please review the form and make corrections.\" (Progressive Enrollment) * If you don't return an `error` object at all and the registration is denied, the following generic message appears to the end user: * \"Registration denied.\" (SSR) * \"Profile update denied.\" (Progressive Enrollment) >**Note:** If you include an error object in your response, no commands are executed and the registration fails. This holds true even if the top-level `errorSummary` and the `errorCauses` objects are omitted.
## Properties
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**errorSummary** | **String** | Human-readable summary of one or more errors | [optional] |
|**errorCauses** | [**List<RegistrationResponseErrorErrorCausesInner>**](RegistrationResponseErrorErrorCausesInner.md) | | [optional] |
## Implemented Interfaces
* Serializable
© 2015 - 2025 Weber Informatics LLC | Privacy Policy