Create users (customers)
A user account allows a customer to access the self-care / customer portal. Depending on the configuration, the customer can manage subscriptions, view invoices or update payment methods.
When do I need this function?
Section titled “When do I need this function?”You need this function if you want to subsequently grant an existing customer access to the self-care / customer portal so that they can manage their data and processes in self-service in the future.
Requirements
Section titled “Requirements”- You are logged in to the tebio business portal.
- You have the necessary permissions to create user accounts.
Step-by-step instructions
Section titled “Step-by-step instructions”Paths to the facility
Section titled “Paths to the facility”In the tebio business portal there is a 1:1 relationship between the customer and the user account. A customer can be assigned a maximum of one access to the self-care / customer portal. There are three options for the system:
- Automatically via hosted pages: If a customer orders their subscription independently via an order page hosted by tebio, a user account is automatically created.
- Directly when creating a customer manually: If you create a new customer, you can create the user account for the self-care / customer portal directly in the fourth step of the form. (You can find details in the article Create customers).
- Additionally to the customer profile: For existing customers without a user account, use the function in the customer profile. This manual route is described in detail below.
Create users later
Section titled “Create users later”To assign a user account to an existing customer:
- Navigate to the detailed view of the desired customer.
- In the left info card, scroll down to the Users card.
- Click +Add User. The Create User dialog opens.
1. Username and Validation Enter a desired username in the Username field, for example test.customer.
[!TIP] tebio checks whether the user name is unique system-wide. If the name is already taken, a warning appears. tebio can suggest available alternatives, for example test.customer123, which you can adopt.
2. Email and Authentication Enter the customer’s email address. This can be used for communication and login depending on the authentication method.
In the Authentication method dropdown, select how the customer should log in later:
- Password: Login via username or email address and password.
- OTP via email: Login without a fixed password. The customer enters their email address and receives a one-time code by email.
- 2FA: Login with second factor, for example password plus OTP via email or password plus OTP via an authenticator app.
3. Required actions Use the checkboxes under Required actions to determine which actions the customer must carry out the next time they log in:
- Update Password: Customer must set a new password.
- Verify email: The customer must confirm their email address via a verification link.
4. Completion Click Create User.
Result
Section titled “Result”Depending on the actions and authentication methods selected, the customer receives a system email, for example for email verification or password assignment. The newly created user account is then displayed in the customer view in the Users card and can be adjusted there if necessary via Edit User.
Notes and typical errors
Section titled “Notes and typical errors”- No multiple users: tebio supports a 1:1 relationship between customer and user account in the business portal. You cannot assign multiple self-care accesses to a customer.
- Integration into existing systems (SSO):
[!NOTE] Keycloak Technology The tebio platform uses Keycloak for identity and access management in the background. If you use existing CRM systems, your own customer portals or apps, the tebio user account can be integrated via single sign-on (SSO). SSO integrations can be implemented via standards such as OAuth and OpenID Connect.
API Notes
Section titled “API Notes”Users can also be managed via the Client-User API, for example from an external application.
| End point | Method | Description | OperationId |
|---|---|---|---|
/v1/client/{realm}/user | GET | Search or list users | searchUser |
/v1/client/{realm}/user | POST | Create user | createUser |
/v1/client/{realm}/user/{userId} | GET | Get user details | getUser |
/v1/client/{realm}/user/{userId} | DELETE | Delete user | deleteUser |
/v1/client/{realm}/user/{userId} | PATCH | Update user data | updateUser |
/v1/client/{realm}/user/own | GET | Retrieve own user | getOwnUser |
/v1/client/{realm}/user/own | PATCH | Update your own user | updateOwnUser |
/v1/client/{realm}/user/checkusername | POST | Check username | checkUserName |
/v1/client/{realm}/user/{userId}/password | PUT | Set password | setUserPassword |
/v1/client/user/list | GET | List users with role | listUsersWithRoles |