User Management API

A central part of HGSP is the administration of users, all done in the user management module.

The features part of the user management module are registration, modification of user and debitor data, transitioning between states (via activation, blocking), notification of changes in data (to SAP, MeinKonto), management of roles, search based on different criteria, blocking and unblocking.

A user represents an entity able to login and place orders, buy plus or online services, act as a service user, administrate its account in Mein Konto, basically exist in the Haufe environment.

The main characteristic of an HGSP user is its ability to authenticate itself (by logging in and getting an SSO token to reuse for most requests) by using the email and the password.

A debitor is the billing entity attached to the user. It has information regarding the company, payment data and billing address. A user must have at least one debitor connection.

Personal address is the private address of the user. It acts as a billing or shipping address if no such addresses exist in the system. The billing address is where the invoice is sent out from SAP and is information pertaining to the debitor. Similarly, the shipping address represents the delivery address.

The payment information is attached to the debitor. It contains data regarding the default payment method (be it invoice or debit), bank data or credit card information.

An anonymous user is an entity able to hold a test license for a certain period of time. Its authentication level is lower than that of a normal user. If a user logs in, a session upgrade mechanism is in place, replacing the anonymous user with a normal one.

View Swagger definition »