From 5e050782be6203a3a49293c4c0c0cb5ed31d1879 Mon Sep 17 00:00:00 2001 From: Andy Munro Date: Fri, 30 Oct 2020 16:24:05 -0400 Subject: [PATCH] KEYCLOAK-16117 applying minor updates to wording and other changes for consistency with CCS standards --- server_admin/topics/users.adoc | 6 ++++-- server_admin/topics/users/con-required-actions.adoc | 4 ++-- server_admin/topics/users/credentials.adoc | 4 ++-- .../users/proc-configuring-user-attributes.adoc | 2 +- server_admin/topics/users/proc-creating-user.adoc | 2 +- server_admin/topics/users/proc-deleting-user.adoc | 2 +- .../topics/users/proc-enabling-terms-conditions.adoc | 4 ++-- .../topics/users/proc-enabling-user-registration.adoc | 3 --- .../topics/users/proc-registering-new-user.adoc | 8 ++++---- server_admin/topics/users/proc-searching-user.adoc | 2 +- .../users/proc-setting-default-required-actions.adoc | 3 +-- .../topics/users/proc-setting-password-user.adoc | 2 +- .../topics/users/proc-setting-required-actions.adoc | 11 +++++------ server_admin/topics/users/recaptcha.adoc | 2 +- server_admin/topics/users/user-registration.adoc | 7 ++++--- 15 files changed, 30 insertions(+), 32 deletions(-) diff --git a/server_admin/topics/users.adoc b/server_admin/topics/users.adoc index 6aa32ecab5..f052e9b206 100644 --- a/server_admin/topics/users.adoc +++ b/server_admin/topics/users.adoc @@ -1,13 +1,15 @@ -== User Management +== Managing Users -This section describes the administration functions for managing users. +From the admin console, you have a wide range actions you can perform to manage users. include::users/proc-searching-user.adoc[leveloffset=2] include::users/proc-creating-user.adoc[leveloffset=2] include::users/proc-deleting-user.adoc[leveloffset=2] include::users/proc-configuring-user-attributes.adoc[leveloffset=2] include::users/credentials.adoc[leveloffset=2] +include::users/proc-setting-password-user.adoc[leveloffset=3] +include::users/proc-creating-otp.adoc[leveloffset=3] include::users/con-required-actions.adoc[leveloffset=2] include::users/impersonation.adoc[leveloffset=2] include::users/user-registration.adoc[leveloffset=2] diff --git a/server_admin/topics/users/con-required-actions.adoc b/server_admin/topics/users/con-required-actions.adoc index 056dd28945..5591eb8661 100644 --- a/server_admin/topics/users/con-required-actions.adoc +++ b/server_admin/topics/users/con-required-actions.adoc @@ -1,9 +1,9 @@ [id="con-required-actions_{context}"] = Required Actions -A user must complete required actions before initially logging in. A user must provide credentials before required actions can be executed. Once a required action is completed, the user does not have to perform the action again. +You can set the actions that a user must perform at the first login. These actions are required after the user provides credentials. After the first login, these actions are no longer required. -Admins can add required actions for each user, in the *Details* tab of the admin console. +You can add required actions for each user in the *Details* tab of the admin console. The following are examples of required action types: diff --git a/server_admin/topics/users/credentials.adoc b/server_admin/topics/users/credentials.adoc index 53491ac27f..790eb0c56b 100644 --- a/server_admin/topics/users/credentials.adoc +++ b/server_admin/topics/users/credentials.adoc @@ -6,7 +6,7 @@ You can manage credentials of a user in the *Credentials* tab. .Credential Management image:{project_images}/user-credentials.png[] -The credentials are listed in a table, which has the following fields: +This tab includes the following fields: Position:: The arrow buttons in the *Position* column allow you to shift the priority of the credential for the user. The topmost credential has the highest priority. The priority determines which credential is displayed first after a user logs in. @@ -26,7 +26,7 @@ Actions:: This column has two actions. Click *Save* to record the value or the user field. Click *Delete* to remove the credential. -You cannot configure other types of credentials for a specific user in the admin console; this is the responsibility of the user. +You cannot configure other types of credentials for a specific user in the admin console; that task is the user's responsibility. You can delete the credentials of a user in the event a user loses an OTP device or if credentials have been compromised. You can only delete credentials of a user in the *Credentials* tab. diff --git a/server_admin/topics/users/proc-configuring-user-attributes.adoc b/server_admin/topics/users/proc-configuring-user-attributes.adoc index 94055f09d8..a0ded5981e 100644 --- a/server_admin/topics/users/proc-configuring-user-attributes.adoc +++ b/server_admin/topics/users/proc-configuring-user-attributes.adoc @@ -1,7 +1,7 @@ [id="proc-configuring-user-attributes_{context}"] = Configuring user attributes -User attributes provide a customized experience for each user. Using user attributes, you can can create a personalized identity for each user in the console. +User attributes provide a customized experience for each user. With user attributes, you can can create a personalized identity for each user in the console. .Prerequisite * You are in the realm where the user exists. diff --git a/server_admin/topics/users/proc-creating-user.adoc b/server_admin/topics/users/proc-creating-user.adoc index 903dc9774c..ba66ec4473 100644 --- a/server_admin/topics/users/proc-creating-user.adoc +++ b/server_admin/topics/users/proc-creating-user.adoc @@ -8,7 +8,7 @@ You create users in the realm where you intend to have applications needed by th * You are in a realm other than the master realm. .Procedure -. In the console, click *Users* in the left menu. +. In the admin console, click *Users* in the left menu. . Click *Add User*, located on the right side of the empty user list. . Enter the details for the new user. + diff --git a/server_admin/topics/users/proc-deleting-user.adoc b/server_admin/topics/users/proc-deleting-user.adoc index 3d72210558..7093e69c90 100644 --- a/server_admin/topics/users/proc-deleting-user.adoc +++ b/server_admin/topics/users/proc-deleting-user.adoc @@ -7,7 +7,7 @@ You can delete a user, who no longer needs access to applications. If a user is * You are in the realm where the user exists. .Procedure -. Click on *Users* in the left menu. This opens the user list page. +. Click on *Users* in the left menu. This action opens the user list page. . Click *View all users* to find the user to delete. + NOTE: Alternatively, you can use the search bar to find a user. diff --git a/server_admin/topics/users/proc-enabling-terms-conditions.adoc b/server_admin/topics/users/proc-enabling-terms-conditions.adoc index 67e2bebe99..fbcf7a852b 100644 --- a/server_admin/topics/users/proc-enabling-terms-conditions.adoc +++ b/server_admin/topics/users/proc-enabling-terms-conditions.adoc @@ -1,7 +1,7 @@ [id="proc-enabling-terms-conditions_{context}"] -= Terms and conditions += Enabling terms and conditions -{project_name} requires new users to accept the terms and conditions before logging in for the first time. +You can enable a required action that new users must accept the terms and conditions before logging into {project_name} for the first time. .Procedure . Click the *Required Actions* tab. diff --git a/server_admin/topics/users/proc-enabling-user-registration.adoc b/server_admin/topics/users/proc-enabling-user-registration.adoc index e0aeb2986e..9b06ad4296 100644 --- a/server_admin/topics/users/proc-enabling-user-registration.adoc +++ b/server_admin/topics/users/proc-enabling-user-registration.adoc @@ -4,9 +4,6 @@ [role="_abstract"] Enable users to self-register. After you enable this setting, a *Register* link is displayed on the login page of the admin console. -.Registration Link -image:{project_images}/registration-link.png[] - .Procedure . Click *Realm Settings* in the left menu. . Click the *Login* tab. diff --git a/server_admin/topics/users/proc-registering-new-user.adoc b/server_admin/topics/users/proc-registering-new-user.adoc index 114a6de7bd..2036d7e374 100644 --- a/server_admin/topics/users/proc-registering-new-user.adoc +++ b/server_admin/topics/users/proc-registering-new-user.adoc @@ -2,16 +2,16 @@ = Registering as a new user [role="_abstract"] -As a new user, you must complete a registration form to log in for the first time. A user must add profile information and a password to the registration form to complete registration. - -.Registration Form -image:{project_images}/registration-form.png[] +As a new user, you must complete a registration form to log in for the first time. You add profile information and a password to register. .Prerequisite * User registration is enabled. .Procedure . Click the *Register* link on the login page. You are directed to the registration page. ++ +.Registration Form +image:{project_images}/registration-form.png[] . Enter the user profile information. . Enter the new password. . Click *Save*. diff --git a/server_admin/topics/users/proc-searching-user.adoc b/server_admin/topics/users/proc-searching-user.adoc index d495d34cf7..ec8322fd11 100644 --- a/server_admin/topics/users/proc-searching-user.adoc +++ b/server_admin/topics/users/proc-searching-user.adoc @@ -1,7 +1,7 @@ [id="proc-searching-user_{context}"] = Searching for a user -Search for a user to view detailed information about the user's groups and roles. +Search for a user to view detailed information about the user, such as the user's groups and roles. .Prerequisite * You are in the realm where the user exists. diff --git a/server_admin/topics/users/proc-setting-default-required-actions.adoc b/server_admin/topics/users/proc-setting-default-required-actions.adoc index bdd9212ef5..b27d878db4 100644 --- a/server_admin/topics/users/proc-setting-default-required-actions.adoc +++ b/server_admin/topics/users/proc-setting-default-required-actions.adoc @@ -1,8 +1,7 @@ [id="proc-setting-default-required-actions_{context}"] = Setting default required actions -You can use the registration link or the *Required Actions* tab to specify the required actions that must be completed by a user before logging in. - +You can determine what actions are required before the first login for any new user created. Once the user is created, these default required actions can be modified for that user. .Procedure diff --git a/server_admin/topics/users/proc-setting-password-user.adoc b/server_admin/topics/users/proc-setting-password-user.adoc index a840021dd7..a0ae26aad0 100644 --- a/server_admin/topics/users/proc-setting-password-user.adoc +++ b/server_admin/topics/users/proc-setting-password-user.adoc @@ -9,7 +9,7 @@ If a user already has a password, it can be reset in the *Reset Password* sectio . Type in a new password, in the *Set Password* section. . Click *Set Password*. + -NOTE: If the *Temporary* radion button is set to *ON*, the password is temporary and the user must change the password after the first login. If a user prefers to create a password that is persistent, the *Temporary* radio button must be set to *OFF* and the user must click *Set Password*. +NOTE: If *Temporary* is set to *ON*, the user must change the password at the first login. To allow users to keep the password supplied, set *Temporary* to *OFF.* The user must click *Set Password* to change the password. + . Alternatively, you can send an email to the user that requests the user reset the password. .. Navigate to the *Reset Actions* list. diff --git a/server_admin/topics/users/proc-setting-required-actions.adoc b/server_admin/topics/users/proc-setting-required-actions.adoc index 2a096aa04f..504104c8f4 100644 --- a/server_admin/topics/users/proc-setting-required-actions.adoc +++ b/server_admin/topics/users/proc-setting-required-actions.adoc @@ -1,15 +1,14 @@ [id="proc-setting-required-actions_{context}"] = Setting required actions -You can add and remove the required actions for existing users in the admin console. - -image:{project_images}/user-required-action.png[] - -.Prerequisite -* You have administrator privileges and are logged into the admin console. +You can set the actions that are required for any user. .Procedure +. Click *Users* in the left column. +. Select a user from the list. . Navigate to the *Required User Actions* list. ++ +image:{project_images}/user-required-action.png[] . Select all the actions you want to add to the account. . Click the *X* next to the action name to remove it. . Click *Save* after you select which actions to add. diff --git a/server_admin/topics/users/recaptcha.adoc b/server_admin/topics/users/recaptcha.adoc index 9a861f4a6c..dd76aea36d 100644 --- a/server_admin/topics/users/recaptcha.adoc +++ b/server_admin/topics/users/recaptcha.adoc @@ -15,7 +15,7 @@ list on this page. image:{project_images}/registration-flow.png[] -Set the 'reCAPTCHA' requirement to `Required` by clicking the appropriate radio button. This will enable +Set the `reCAPTCHA` requirement to `Required` by clicking the appropriate radio button. This will enable reCAPTCHA on the screen. Next, you have to enter in the reCAPTCHA site key and secret that you generated at the Google reCAPTCHA Website. Click on the 'Actions' button that is to the right of the reCAPTCHA flow entry, then "Config" link, and enter in the reCAPTCHA site key and secret on this config page. diff --git a/server_admin/topics/users/user-registration.adoc b/server_admin/topics/users/user-registration.adoc index 21b5d2ad6a..cc1695fa52 100644 --- a/server_admin/topics/users/user-registration.adoc +++ b/server_admin/topics/users/user-registration.adoc @@ -2,11 +2,12 @@ = User Registration [role="_abstract"] -You can use {project_name} as a third-party authorization server to manage application users. Administrators can add users or a users can self-register. +You can use {project_name} as a third-party authorization server to manage application users, including users who self-register. If you enable self-registration, the login page displays a registration link so that user can create an account. -You can enable {project_name} to allow user self-registration. When enabled, the login page displays a registration link that the user can click to create an account. +.Registration Link +image:{project_images}/registration-link.png[] -A user must add profile information to the registration form to complete registration. The registration form can be customized by removing or adding additional fields that must be completed by a user. A user can detect a valid username and email by using the registration form. +A user must add profile information to the registration form to complete registration. The registration form can be customized by removing or adding the fields that must be completed by a user. include::proc-enabling-user-registration.adoc[leveloffset=3] include::proc-registering-new-user.adoc[leveloffset=3]