Skip to content

Commit cb72ad3

Browse files
committed
add how to add user in keycloak without personal Space
1 parent 29d87ac commit cb72ad3

9 files changed

Lines changed: 36 additions & 27 deletions

File tree

docs/admin/configuration/authentication-and-user-management/keycloak-user.md

Lines changed: 36 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -16,68 +16,77 @@ One of the most frequently requested features by administrators has been support
1616

1717
Although OpenCloud does not natively support this method, similar functionality can be achieved using Keycloak for user management.
1818

19-
## Step 1: Assign Admin Permissions in Keycloak
19+
## Assign Admin Permissions in Keycloak
2020

2121
To manage users and groups for OpenCloud, you need a user with administrative privileges in the Keycloak realm.
2222

23-
1. Log in to Keycloak as an admin.
24-
2. Navigate to the OpenCloud realm:
25-
[https://keycloak.keycloak-daily.opencloud.rocks/admin/openCloud/console/#/openCloud](https://keycloak.keycloak-daily.opencloud.rocks/admin/openCloud/console/#/openCloud)
26-
3. Assign appropriate roles (such as `realm-admin`) to the user you want to promote.
23+
- Log in to Keycloak as an admin.
24+
- Navigate to the OpenCloud realm
25+
- Assign appropriate roles (such as `manage-user` and `view-users`) to the user you want to promote.
2726

28-
> Example: A user named `dennis` is assigned as a Realm Admin.
27+
Example: A user named `dennis` is assigned as a Realm Admin.
28+
29+
<img src={require(".././img/keycloak/add-user/set-admin-roles.png").default} alt="Add admin roles to user" width="1920"/>
2930

3031
Once assigned, the user can log in as a Realm Administrator and access user and group management.
3132

32-
## Step 2: Add New Users or Groups
33+
## Add New User with standard rights (no Space)
3334

3435
With admin permissions, you can now create users and groups:
3536

36-
- Navigate to the Users section in the Keycloak Admin Console.
37-
- Click Add User.
38-
- Fill in the required user details (e.g., username, email).
39-
- Optionally assign the user to one or more groups.
40-
- Assign roles to define their access level.
37+
- Login in Keycloak with the user who has admin rights
4138

42-
### Recommended Role: `OpenCloudGuest`
39+
- Navigate to the "Users" section in the Keycloak Admin Console
4340

44-
Assigning the `OpenCloudGuest` role ensures that the user does not receive a personal space in OpenCloud. This setup is ideal for guest or lightweight accounts.
41+
- Click Add User
42+
<img src={require(".././img/keycloak/add-user/add-user.png").default} alt="Add user" width="1920"/>
4543

46-
## Step 3: Configure User Settings
44+
- Fill in the required user details (e.g., username, email)
45+
<img src={require(".././img/keycloak/add-user/fill-out-userinfo.png").default} alt="Fill out user information" width="1920"/>
4746

48-
Once the user is created, you can define mandatory actions:
47+
- Optionally assign the user to one or more groups.
4948

50-
- Set an initial password.
51-
- Require the user to update their profile on first login.
52-
- Require email verification.
49+
- Click on "Create"
5350

54-
These actions can be set under the User Settings > Required Actions section.
51+
- Set an inital password
52+
53+
<img src={require(".././img/keycloak/add-user/set-password.png").default} alt="Set initial user password" width="1920"/>
5554

5655
## First Login Experience for Guest Users
5756

5857
When a guest user logs in for the first time, they will:
5958

60-
1. Be prompted to change their password.
61-
2. Update their profile (name, email, etc.).
62-
3. Verify their email address.
59+
- Be prompted to change their password
60+
- Update their profile (name, email, etc.)
61+
- Verify their email address
62+
63+
if this was set before.
6364

6465
After successful login, they will not receive a personal space — fulfilling the guest user requirement.
6566

67+
<img src={require(".././img/keycloak/add-user/guest-login.png").default} alt="Guest login" width="1920"/>
68+
6669
## Optional: Enable Self Registration
6770

6871
You can allow users to register themselves without manual creation.
6972

7073
To enable self-registration:
7174

72-
1. Go to the Login settings in the OpenCloud realm.
73-
2. Enable the User Registration option.
75+
- Log in to Keycloak as an admin.
76+
- Go to the Login settings in the OpenCloud realm.
77+
- Enable the User Registration option.
78+
79+
<img src={require(".././img/keycloak/add-user/enable-self-registration.png").default} alt="Enable self registration" width="1920"/>
7480

7581
### Self Registration Flow
7682

7783
- Users see a Register option on the login screen.
84+
85+
<img src={require(".././img/keycloak/add-user/register-button.png").default} alt="Register Button" width="1920"/>
86+
7887
- They complete the registration form.
79-
- After submission, they receive a verification email.
80-
- Once verified, they can log in with their credentials.
88+
89+
<img src={require(".././img/keycloak/add-user/fill-out-registration-form.png").default} alt="Fill out the registration form" width="1920"/>
8190

8291
## Summary
8392

165 KB
Loading
325 KB
Loading
242 KB
Loading
206 KB
Loading
202 KB
Loading
209 KB
Loading
313 KB
Loading
137 KB
Loading

0 commit comments

Comments
 (0)