In addition to the method-specific response data, the Loginapp REST API provides additional and custom attributes in many REST responses as follows:
- Additional attributes are determined by the state of the flow engine, as indicated by the
nextStep
code in the response. Additional attributes provide relevant information about the current step and serve to provide the user with additional information in the Loginapp UI or in a REST client. - Custom attributes depend on the configuration of the step. Custom attributes may be configured in situations where a REST client requires information that goes beyond the standard use cases.
Example of additional attributes: The REST response in an mTAN verification step used in an authentication flow returns the following additional attributes:
"attributes": { "nextAuthStep": "MTAN_OTP_REQUIRED", "phoneNumber": "+4123456789", "resendPossible": true, "customAttributes": { "myKey": "my value" } }
The complete list of additional attributes is documented in the Loginapp REST API Reference. It lists all the additional attributes provided in the response for each next step code. For each type of REST API, a separate table with information about additional attributes has been added to the REST API documentation.