diff --git a/docs/manager/group-management.md b/docs/manager/group-management.md new file mode 100644 index 0000000..baa06c0 --- /dev/null +++ b/docs/manager/group-management.md @@ -0,0 +1,272 @@ +--- +sidebar_position: 4 +--- + +# Groups + +## Membership Managment + +### View Group Members + +1. Login to [Keycloak Account Console](https://kc-example/account/#/) using any of the login credentials already linked to your RCIAM account. +2. Locate your group in the [Group Management Page](https://kc-example/account/#/groups/admingroups) and access the Group Configuration Page by clicking it. +![Admin Groups View](../../static/img/manager/admin-groups.png) +3. To view the existing members, select the Group Members tab. +![Admin Group View](../../static/img/manager/admin-group-view-members-tab.png) +![Admin Group Members](../../static/img/manager/admin-group-members.png) + +### Add Group Members + +#### By Invitation + +Users can be added to a group by sending an email invitation. Users receiving the invitation can login to Keycloak Account Console with their RCIAM account and accept or reject the invitation to the group. + +Sending an email invitation to a User to join a group can be achieved by: + +1. Login to [Keycloak Account Console](https://kc-example/account/#/) using any of the login credentials already linked to your RCIAM account. +2. Locate your group in the [Group Management Page](https://kc-example/account/#/groups/admingroups) and access the Group Configuration Page by clicking it. +![Admin Groups View](../../static/img/manager/admin-groups.png) +3. Select the Group Members tab. +![Admin Group Members](../../static/img/manager/admin-group-view-members-tab.png) +4. Click the Invite User button that opens the invitation pop-up window. +![Admin Group Members Invite](../../static/img/manager/admin-group-members-invite.png) +5. Select an Enrollment Configuration +![Admin Group Members Invite Step 1](../../static/img/manager/admin-group-members-invite-step1.png) +6. Select the role(s) that you want the user have in the Group and click Next +![Admin Group Members Invite Step 2](../../static/img/manager/admin-group-members-invite-step2.png) +7. Select the user from the drop down selection input or enter an email address and click Send Invitation. +![Admin Group Members Invite Step 3](../../static/img/manager/admin-group-members-invite-step3.png) + +> **_NOTE:_** Once a user accepts or reject an invitation email notification will be sent to admins of the group + +#### By Enrollment URL + +Users can be added to a group by creating an Enrollment Request through an enrollment url. There are two types of enrollment url, one that contains all public/visible group Enrollments and one that is tied to a specific Enrollment. + +Α) Sharing an Enrollment URL that contains all the public/visible group Enrollments following these steps: + +1. Login to [Keycloak Account Console](https://kc-example/account/#/) using any of the login credentials already linked to your RCIAM account. +2. Locate your group in the [Group Management Page](https://kc-example/account/#/groups/admingroups) and access the Group Configuration Page by clicking it. +![Admin Groups View](../../static/img/manager/admin-groups.png) +3. Select the more options and from the available options select the “Copy enrollment link to this group”. +![Admin Group Invite Url](../../static/img/manager/admin-group-invite-url.png) +4. Share the copied Enrollment URL with the User. + +> **_NOTE:_** Once a user submits an enrollment request admins of the group will receive an email notification. + +B) Sharing an Enrollment URL for a specific Enrollment + +1. Login to [Keycloak Account Console](https://kc-example/account/#/) using any of the login credentials already linked to your RCIAM account. +2. Locate your group in the [Group Management Page](https://kc-example/account/#/groups/admingroups) and access the Group Configuration Page by clicking it. +![Admin Groups View](../../static/img/manager/admin-groups.png) +3. Select the Group Enrollment Tab +![Admin Group Enrollment Tab](../../static/img/manager/admin-group-enrollments-tab.png) +4. Locate the desired Enrollment making sure it is active +5. Select the more options and from the available options select the “Copy enrollment link to this group”. +![Admin Group Enrollment Invite Url](../../static/img/manager/admin-group-invite-url-specific.png) +6. Share the copied Enrollment URL with the User. + +> **_NOTE:_** Once a user submits an enrollment request admins of the group will receive an email notification. + +### Remove Member from Group + +1. Login to [Keycloak Account Console](https://kc-example/account/#/) using any of the login credentials already linked to your RCIAM account. +2. Locate your group in the [Group Management Page](https://kc-example/account/#/groups/admingroups) and access the Group Configuration Page by clicking it. +![Admin Groups View](../../static/img/manager/admin-groups.png) +3. Select the Group Members tab. +![Admin Group Members](../../static/img/manager/admin-group-view-members-tab.png) +4. Locate the User you want to remove from the group +5. Click the X button and then the Yes button at the confirmation pop-up window +![Admin Group Remove Member](../../static/img/manager/admin-group-remove-member.png) + +> **_NOTE:_** Once a group member is removed admins of the group and the removed user will receive an email notification + +### Manage Group Member Roles + +1. Login to [Keycloak Account Console](https://kc-example/account/#/) using any of the login credentials already linked to your RCIAM account. +2. Locate your group in the [Group Management Page](https://kc-example/account/#/groups/admingroups) and access the Group Configuration Page by clicking it. +![Admin Groups View](../../static/img/manager/admin-groups.png) +3. Select the Group Members tab. +![Admin Group Members](../../static/img/manager/admin-group-view-members-tab.png) +4. Locate the User you want to alter their roles. +5. Click the edit button next to their assigned roles. +![Admin Group Edit Member Roles](../../static/img/manager/admin-group-edit-member-roles.png) +6. Alter their roles by selecting the desired ones from the available options. +![Admin Group Edit Member Roles Window](../../static/img/manager/admin-group-edit-member-roles-window.png) +7. To save edited member roles click the OK button. + +### Suspend or Activate Group Member + +User memberships can be suspended or activated by a group admin by following these steps: + +1. Login to [Keycloak Account Console](https://kc-example/account/#/) using any of the login credentials already linked to your RCIAM account. +2. Locate your group in the [Group Management Page](https://kc-example/account/#/groups/admingroups) and access the Group Configuration Page by clicking it. +![Admin Groups View](../../static/img/manager/admin-groups.png) +3. Select the Group Members tab. +![Admin Group Members](../../static/img/manager/admin-group-view-members-tab.png) +4. Locate the User you want to suspend or activate their membership. +5. Click the suspend/activate button to open the confirmation pop-up window. +![Admin Group Member Action](../../static/img/manager/admin-group-member-action.png) +6. Optionally provide a justification for your action that will be included in the notification sent to the User and the group Admins. +![Admin Group Member Action Confirmation](../../static/img/manager/admin-group-member-action-confirmation.png) +7. Click the YES button to submit your action + +> **_NOTE:_** Once a group member is activated/suspended, admins of the group and the user will receive an email notification. + +## Admin Management + +### View Group Admins + +1. Login to [Keycloak Account Console](https://kc-example/account/#/) using any of the login credentials already linked to your RCIAM account. +2. Locate your group in the [Group Management Page](https://kc-example/account/#/groups/admingroups) and access the Group Configuration Page by clicking it. +![Admin Groups View](../../static/img/manager/admin-groups.png) +3. Select the Group Admins Tab. +![Admin Groups Admin Tab](../../static/img/manager/admin-group-admin-tab.png) +4. Group Admin details are available in list form. +![Admin Groups Admin Details](../../static/img/manager/admin-group-details.png) + +### Add Group Admin + +1. Login to [Keycloak Account Console](https://kc-example/account/#/) using any of the login credentials already linked to your RCIAM account. +2. Locate your group in the [Group Management Page](https://kc-example/account/#/groups/admingroups) and access the Group Configuration Page by clicking it. +![Admin Groups View](../../static/img/manager/admin-groups.png) +3. Select the Group Admins Tab. +![Admin Groups Admin Tab](../../static/img/manager/admin-group-admin-tab.png) +4. Use the input located in the Add New Group Admin section to search for a user to add as a group admin, or type a valid email address to send an invitation. +![Admin Groups Admin Discovery](../../static/img/manager/admin-group-admin-discovery.png) + +> **_NOTE:_** Selecting a user discovered in the select input and will add the user immediately. + +> **_NOTE:_** Once a User accepts or rejects an invitation and when a user is added directly to a group group admins receive email notification + +### Remove Group Admin + +1. Login to [Keycloak Account Console](https://kc-example/account/#/) using any of the login credentials already linked to your RCIAM account. +2. Locate your group in the [Group Management Page](https://kc-example/account/#/groups/admingroups) and access the Group Configuration Page by clicking it. +![Admin Groups View](../../static/img/manager/admin-groups.png) +3. Select the Group Admins Tab. +![Admin Groups Admin Tab](../../static/img/manager/admin-group-admin-tab.png) +4. Locate User you want to remove from being an admin and click the X button +![Admin Groups Admin Remove](../../static/img/manager/admin-group-admin-remove.png) +5. Click the YES button in the confirmation pop-up window + +> **_NOTE:_** Once a group admin is removed from a group he and all other admins are sent an email notification + +## Manage Enrollment Configurations + +User enrols to a group using a specific enrollment configuration, each enrollment has a configuration that defines the following things: + +**Enrollment Name:** The identifying name of the enrollment. + +**Membership Expiration:** The duration of the memberships of users enrolled with this enrollment. + +> Membership Expiration can also be indefinite is configuration allows it. + +**Start Date:** Allows for memberships to be activated in future time and not directly after an enrollment is completed. + +**Requires Approval:** If true enrollment requests submitted by user need to be approved by an administrator. + +**Comments:** If activated Users that are submitting an enrollment request need to also provide additional information. + +**Acceptable Use Policy (AUP):** Acceptable Use Policy in the form of a URL. + +**Available Roles:** Available roles to users using this enrollment. + +**Multiselect Roles:** If activated users using this enrollment can select multiple roles. + +**Visible to non-members:** If activated the enrollment will be available in the Group Enrollment discovery page. + +**Is Active:** Only active enrollments can be used for user enrollments. + + +### Create Enrollment Configuration + +1. Login to [Keycloak Account Console](https://kc-example/account/#/) using any of the login credentials already linked to your RCIAM account. +2. Locate your group in the [Group Management Page](https://kc-example/account/#/groups/admingroups) and access the Group Configuration Page by clicking it. +![Admin Groups View](../../static/img/manager/admin-groups.png) +3. Select the Group Enrollment Tab +![Admin Group Enrollment Tab](../../static/img/manager/admin-group-enrollments-tab.png) +4. Click on the + button located in the table header to open the creation window +![Admin Group Create Enrollment](../../static/img/manager/admin-group-create-enrollment.png) +5. Fill the form with the necessary information and click the Create button to create the Enrollment Configuration +![Admin Group Create Enrollment Form](../../static/img/manager/admin-group-create-enrollment-form.png) + +### Update Enrollment Configuration + +1. Login to [Keycloak Account Console](https://kc-example/account/#/) using any of the login credentials already linked to your RCIAM account. +2. Locate your group in the [Group Management Page](https://kc-example/account/#/groups/admingroups) and access the Group Configuration Page by clicking it. +![Admin Groups View](../../static/img/manager/admin-groups.png) +3. Select the Group Enrollment Tab +![Admin Group Enrollment Tab](../../static/img/manager/admin-group-enrollments-tab.png) +4. Locate the Enrollment Configuration you want to update in the list. +5. Select the Enrollment Configuration you want to update by clicking on it. +![Admin Group Select Enrollment](../../static/img/manager/admin-group-select-enrollment.png) +6. Edit the fields you want to update and click the SAVE button to update the Enrollment Configuration +![Admin Group Update Enrollment Form](../../static/img/manager/admin-group-update-enrollment-form.png) + +### Delete Enrollment Configuration + +1. Login to [Keycloak Account Console](https://kc-example/account/#/) using any of the login credentials already linked to your RCIAM account. +2. Locate your group in the [Group Management Page](https://kc-example/account/#/groups/admingroups) and access the Group Configuration Page by clicking it. +![Admin Groups View](../../static/img/manager/admin-groups.png) +3. Select the Group Enrollment Tab +![Admin Group Enrollment Tab](../../static/img/manager/admin-group-enrollments-tab.png) +4. Locate the Enrollment Configuration you want to delete in the list. +5. Select the Enrollment Configuration you want to delete by clicking on it. +![Admin Group Select Enrollment](../../static/img/manager/admin-group-select-enrollment.png) +6. Click the trash icon next to the Enrollment Configuration name. +![Admin Group Delete Enrollment](../../static/img/manager/admin-group-delete-enrollment.png) +7. Click the YES button to delete the Enrollment Configuration in the confirmation pop-up window. + +## Review Enrollment Request + +Once a enrollment request to join a group is submitted admins of the group are notified to review the request if that request requires approval. + +To review an enrollment request follow these steps: + +1. Login to [Keycloak Account Console](https://kc-example/account/#/) using any of the login credentials already linked to your RCIAM account. +2. Access the [Review Enrollment Requests](https://kc-example/account/#/groups/groupenrollments) page available in the Group Management Section. +![Admin Groups View Enrollment Requests](../../static/img/manager/admin-group-review-enrollment-sidebar.png) +3. Locate the enrollment request In the list of all pending requests and click on the Review Button to open the Review Page. +![Admin Groups Review Select Enrollment Requests](../../static/img/manager/admin-group-review-enrollment-select.png) +4. Check all the information about the User and his Membership. +5. Optionally Leave a justification comment for your Review Action. +6. Approve the request by clicking the green Approve button or reject it by clicking the red Reject button. +![Admin Groups Review Enrollment Requests Action](../../static/img/manager/admin-group-review-enrollment-action.png) + +> **_NOTE:_** After approving or denying an enrollment request email notifications are sent to the requesting user and other administrators of the group + +## Enrollment Request Details + +Information Available when reviewing an enrollment request: + +### General Details + +**Submission Date:** Date and time of the submission of the request by the user. + +**Enrollment Request Status:** Status of the request. (Pending Approval, Approved, Rejected) + +### User Details + +**Full Name:** Full name of the user submitting the request. + +**Email:** Email address of the user submitting the request. + +**Identity Assurance:** ???? + +**Linked Identity Providers:** + +### Membership Details + +**Group Name:** Name of the group + +**Enrollment Name:** Name of the enrollment configuration used + +**Group Roles:** List of the roles that the user will acquire from this enrollment request + +**Acceptable User Policy (AUP):** Link of the AUP that the user has approved + +**Membership Expiration Days:** The duration of the membership in days + +**Comments (or custom name):** Additional information from the user submitting the request. + diff --git a/static/img/manager/admin-group-admin-discovery.png b/static/img/manager/admin-group-admin-discovery.png new file mode 100644 index 0000000..b32bb1f Binary files /dev/null and b/static/img/manager/admin-group-admin-discovery.png differ diff --git a/static/img/manager/admin-group-admin-remove.png b/static/img/manager/admin-group-admin-remove.png new file mode 100644 index 0000000..8257ae0 Binary files /dev/null and b/static/img/manager/admin-group-admin-remove.png differ diff --git a/static/img/manager/admin-group-admin-tab.png b/static/img/manager/admin-group-admin-tab.png new file mode 100644 index 0000000..b79569c Binary files /dev/null and b/static/img/manager/admin-group-admin-tab.png differ diff --git a/static/img/manager/admin-group-create-enrollment-form.png b/static/img/manager/admin-group-create-enrollment-form.png new file mode 100644 index 0000000..ab23fd5 Binary files /dev/null and b/static/img/manager/admin-group-create-enrollment-form.png differ diff --git a/static/img/manager/admin-group-create-enrollment.png b/static/img/manager/admin-group-create-enrollment.png new file mode 100644 index 0000000..af535e2 Binary files /dev/null and b/static/img/manager/admin-group-create-enrollment.png differ diff --git a/static/img/manager/admin-group-delete-enrollment.png b/static/img/manager/admin-group-delete-enrollment.png new file mode 100644 index 0000000..be5057e Binary files /dev/null and b/static/img/manager/admin-group-delete-enrollment.png differ diff --git a/static/img/manager/admin-group-details.png b/static/img/manager/admin-group-details.png new file mode 100644 index 0000000..ee60dad Binary files /dev/null and b/static/img/manager/admin-group-details.png differ diff --git a/static/img/manager/admin-group-edit-member-roles-window.png b/static/img/manager/admin-group-edit-member-roles-window.png new file mode 100644 index 0000000..38e62a9 Binary files /dev/null and b/static/img/manager/admin-group-edit-member-roles-window.png differ diff --git a/static/img/manager/admin-group-edit-member-roles.png b/static/img/manager/admin-group-edit-member-roles.png new file mode 100644 index 0000000..d6f1da2 Binary files /dev/null and b/static/img/manager/admin-group-edit-member-roles.png differ diff --git a/static/img/manager/admin-group-enrollments-tab.png b/static/img/manager/admin-group-enrollments-tab.png new file mode 100644 index 0000000..040c86a Binary files /dev/null and b/static/img/manager/admin-group-enrollments-tab.png differ diff --git a/static/img/manager/admin-group-invite-url-specific.png b/static/img/manager/admin-group-invite-url-specific.png new file mode 100644 index 0000000..d06de14 Binary files /dev/null and b/static/img/manager/admin-group-invite-url-specific.png differ diff --git a/static/img/manager/admin-group-invite-url.png b/static/img/manager/admin-group-invite-url.png new file mode 100644 index 0000000..f08bb66 Binary files /dev/null and b/static/img/manager/admin-group-invite-url.png differ diff --git a/static/img/manager/admin-group-member-action-confirmation.png b/static/img/manager/admin-group-member-action-confirmation.png new file mode 100644 index 0000000..e59e76b Binary files /dev/null and b/static/img/manager/admin-group-member-action-confirmation.png differ diff --git a/static/img/manager/admin-group-member-action.png b/static/img/manager/admin-group-member-action.png new file mode 100644 index 0000000..2266297 Binary files /dev/null and b/static/img/manager/admin-group-member-action.png differ diff --git a/static/img/manager/admin-group-members-invite-step1.png b/static/img/manager/admin-group-members-invite-step1.png new file mode 100644 index 0000000..89cca7b Binary files /dev/null and b/static/img/manager/admin-group-members-invite-step1.png differ diff --git a/static/img/manager/admin-group-members-invite-step2.png b/static/img/manager/admin-group-members-invite-step2.png new file mode 100644 index 0000000..da68df3 Binary files /dev/null and b/static/img/manager/admin-group-members-invite-step2.png differ diff --git a/static/img/manager/admin-group-members-invite-step3.png b/static/img/manager/admin-group-members-invite-step3.png new file mode 100644 index 0000000..20511da Binary files /dev/null and b/static/img/manager/admin-group-members-invite-step3.png differ diff --git a/static/img/manager/admin-group-members-invite.png b/static/img/manager/admin-group-members-invite.png new file mode 100644 index 0000000..e49755d Binary files /dev/null and b/static/img/manager/admin-group-members-invite.png differ diff --git a/static/img/manager/admin-group-members.png b/static/img/manager/admin-group-members.png new file mode 100644 index 0000000..a0c1df8 Binary files /dev/null and b/static/img/manager/admin-group-members.png differ diff --git a/static/img/manager/admin-group-remove-member.png b/static/img/manager/admin-group-remove-member.png new file mode 100644 index 0000000..e48edc6 Binary files /dev/null and b/static/img/manager/admin-group-remove-member.png differ diff --git a/static/img/manager/admin-group-review-enrollment-action.png b/static/img/manager/admin-group-review-enrollment-action.png new file mode 100644 index 0000000..2a77a93 Binary files /dev/null and b/static/img/manager/admin-group-review-enrollment-action.png differ diff --git a/static/img/manager/admin-group-review-enrollment-select.png b/static/img/manager/admin-group-review-enrollment-select.png new file mode 100644 index 0000000..5984b6f Binary files /dev/null and b/static/img/manager/admin-group-review-enrollment-select.png differ diff --git a/static/img/manager/admin-group-review-enrollment-sidebar.png b/static/img/manager/admin-group-review-enrollment-sidebar.png new file mode 100644 index 0000000..753ce32 Binary files /dev/null and b/static/img/manager/admin-group-review-enrollment-sidebar.png differ diff --git a/static/img/manager/admin-group-select-enrollment.png b/static/img/manager/admin-group-select-enrollment.png new file mode 100644 index 0000000..d4d1ce6 Binary files /dev/null and b/static/img/manager/admin-group-select-enrollment.png differ diff --git a/static/img/manager/admin-group-update-enrollment-form.png b/static/img/manager/admin-group-update-enrollment-form.png new file mode 100644 index 0000000..279fa13 Binary files /dev/null and b/static/img/manager/admin-group-update-enrollment-form.png differ diff --git a/static/img/manager/admin-group-view-members-tab.png b/static/img/manager/admin-group-view-members-tab.png new file mode 100644 index 0000000..7c9e926 Binary files /dev/null and b/static/img/manager/admin-group-view-members-tab.png differ diff --git a/static/img/manager/admin-groups.png b/static/img/manager/admin-groups.png new file mode 100644 index 0000000..342ffef Binary files /dev/null and b/static/img/manager/admin-groups.png differ