From fef494fc309bfa0fb8cda57a6f8fdee8aa80a83b Mon Sep 17 00:00:00 2001 From: Joan Edwards Date: Wed, 25 Nov 2020 19:46:17 +0000 Subject: [PATCH] update content with corrections (#42) * update content with corrections * updates --- server_admin/topics/users.adoc | 36 ++++++++++++------- .../topics/users/con-required-actions.adoc | 4 +-- .../topics/users/con-user-impersonation.adoc | 2 +- .../topics/users/con-user-registration.adoc | 2 -- .../proc-configuring-user-attributes.adoc | 5 ++- .../topics/users/proc-creating-otp.adoc | 2 ++ .../topics/users/proc-creating-user.adoc | 8 ++--- .../topics/users/proc-deleting-user.adoc | 6 ++-- ...port.adoc => proc-enabling-recaptcha.adoc} | 29 +++++++++------ .../proc-enabling-user-registration.adoc | 4 +-- .../users/proc-registering-new-user.adoc | 2 +- .../topics/users/proc-searching-user.adoc | 2 +- ...proc-setting-default-required-actions.adoc | 2 +- .../users/proc-setting-password-user.adoc | 2 ++ .../users/proc-setting-required-actions.adoc | 2 +- 15 files changed, 63 insertions(+), 45 deletions(-) rename server_admin/topics/users/{proc-enabling-recaptcha-support.adoc => proc-enabling-recaptcha.adoc} (56%) diff --git a/server_admin/topics/users.adoc b/server_admin/topics/users.adoc index 52a5f3c867..382af014dc 100644 --- a/server_admin/topics/users.adoc +++ b/server_admin/topics/users.adoc @@ -1,18 +1,28 @@ == Managing Users -From the admin console, you have a wide range of actions you can perform to manage users. +From the administrator console, you have a wide range of 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/ref-user-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/con-user-impersonation.adoc[leveloffset=2] -include::users/con-user-registration.adoc[leveloffset=2] -include::users/proc-enabling-recaptcha-support.adoc[leveloffset=2] -include::users/ref-personal-data-collected.adoc[leveloffset=2] +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/ref-user-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::proc-setting-required-actions.adoc[leveloffset=+3] +include::proc-setting-default-required-actions.adoc[leveloffset=+3] +include::proc-enabling-terms-conditions.adoc[leveloffset=+3] + +include::users/con-user-impersonation.adoc[leveloffset=+2] + +include::users/con-user-registration.adoc[leveloffset=+2] +include::proc-enabling-user-registration.adoc[leveloffset=3] +include::proc-registering-new-user.adoc[leveloffset=3] + +include::users/proc-enabling-recaptcha.adoc[leveloffset=+2] +include::users/ref-personal-data-collected.adoc[leveloffset=+2] diff --git a/server_admin/topics/users/con-required-actions.adoc b/server_admin/topics/users/con-required-actions.adoc index 06e201fcef..c2fc432926 100644 --- a/server_admin/topics/users/con-required-actions.adoc +++ b/server_admin/topics/users/con-required-actions.adoc @@ -24,6 +24,4 @@ Update Profile:: The user must update profile information, such as name, address, email, and phone number. -include::proc-setting-required-actions.adoc[leveloffset=3] -include::proc-setting-default-required-actions.adoc[leveloffset=3] -include::proc-enabling-terms-conditions.adoc[leveloffset=3] + diff --git a/server_admin/topics/users/con-user-impersonation.adoc b/server_admin/topics/users/con-user-impersonation.adoc index 501a9bfaf6..8544cbd25b 100644 --- a/server_admin/topics/users/con-user-impersonation.adoc +++ b/server_admin/topics/users/con-user-impersonation.adoc @@ -14,7 +14,7 @@ image:{project_images}/user-details.png[] * If the administrator and the user are in the same realm, then the administrator will be logged out and automatically logged in as the user being impersonated. * If the administrator and user are not in the same realm, the administrator will remain logged in, and additionally will be logged in as the user in that user's realm. -In both instances, the browser redirects to the impersonated user's *User Account Management* page. +In both instances, the *User Account Management* page of the impersonated user is displayed. You can access the *Impersonate* button from the *Details* tab on the *Users* page. diff --git a/server_admin/topics/users/con-user-registration.adoc b/server_admin/topics/users/con-user-registration.adoc index d646a756ff..630a9c5a13 100644 --- a/server_admin/topics/users/con-user-registration.adoc +++ b/server_admin/topics/users/con-user-registration.adoc @@ -13,8 +13,6 @@ 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 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] [role="_additional-resources"] .Additional resources diff --git a/server_admin/topics/users/proc-configuring-user-attributes.adoc b/server_admin/topics/users/proc-configuring-user-attributes.adoc index 28b96c809f..5f8e491e4f 100644 --- a/server_admin/topics/users/proc-configuring-user-attributes.adoc +++ b/server_admin/topics/users/proc-configuring-user-attributes.adoc @@ -7,11 +7,14 @@ User attributes provide a customized experience for each user. You can create a personalized identity for each user in the console by configuring user attributes. +.Users +image:{project_images}/user-attributes.png[] + .Prerequisite * You are in the realm where the user exists. .Procedure -. Click *Users* in the left menu. +. Click *Users* in the menu. . Select a user to manage. . Click the *Attributes* tab. . Enter the attribute name in the *Key* field. diff --git a/server_admin/topics/users/proc-creating-otp.adoc b/server_admin/topics/users/proc-creating-otp.adoc index 0ee777d8f5..ab387053a8 100644 --- a/server_admin/topics/users/proc-creating-otp.adoc +++ b/server_admin/topics/users/proc-creating-otp.adoc @@ -14,6 +14,8 @@ Alternatively, you can send an email to the user that requests the user reset th * You are logged in to the appropriate realm. .Procedure +. Click *Users* in the main menu. The user list page is displayed. +. Select a user. . Navigate to the *Reset Actions* list. . Click *Configure OTP*. . Click *Send Email*. The sent email contains a link that directs the user to the OTP setup page. diff --git a/server_admin/topics/users/proc-creating-user.adoc b/server_admin/topics/users/proc-creating-user.adoc index 82ee6dc81b..fe3b16ad8d 100644 --- a/server_admin/topics/users/proc-creating-user.adoc +++ b/server_admin/topics/users/proc-creating-user.adoc @@ -12,8 +12,8 @@ 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 admin console, click *Users* in the left menu. -. Click *Add User* on the right side of the empty user list. +. Click *Users* in the menu. +. Click *Add User*. . Enter the details for the new user. ifdef::standalone[] @@ -24,10 +24,10 @@ NOTE: *Username* is the only required field. endif::[] ifdef::api-management[] -. Set *Email Verified* to *ON*. +. Toggle *Email Verified* to *ON*. . Click *Save*. . In the *Credentials* tab, set the password in both fields. -.. Set *Temporary* to *OFF* to avoid resetting the password during the next log in. +.. Toggle *Temporary* to *OFF* to avoid resetting the password during the next log in. .. Click *Reset Password*. .. Click *Change Password*. .. Click *Save*. diff --git a/server_admin/topics/users/proc-deleting-user.adoc b/server_admin/topics/users/proc-deleting-user.adoc index f58cc822ab..d0858ba053 100644 --- a/server_admin/topics/users/proc-deleting-user.adoc +++ b/server_admin/topics/users/proc-deleting-user.adoc @@ -7,12 +7,10 @@ You can delete a user, who no longer needs access to applications. If a user is deleted, the user profile and data is also deleted. -.Prerequisite -* You are in the realm where the user exists. .Procedure -. Click on *Users* in the left menu. This action opens the user list page. -. Click *View all users* to find the user to delete. +. Click on *Users* in the menu. The user list page is displayed. +. Click *View all users* to find a user to delete. + NOTE: Alternatively, you can use the search bar to find a user. + diff --git a/server_admin/topics/users/proc-enabling-recaptcha-support.adoc b/server_admin/topics/users/proc-enabling-recaptcha.adoc similarity index 56% rename from server_admin/topics/users/proc-enabling-recaptcha-support.adoc rename to server_admin/topics/users/proc-enabling-recaptcha.adoc index 148ad8d006..a16cf4f3cc 100644 --- a/server_admin/topics/users/proc-enabling-recaptcha-support.adoc +++ b/server_admin/topics/users/proc-enabling-recaptcha.adoc @@ -2,8 +2,8 @@ // // server_admin/topics/users.adoc -[id="proc-enabling-recaptcha-support_{context}"] -= Enabling reCAPTCHA Support +[id="proc-enabling-recaptcha_{context}"] += Enabling reCAPTCHA [role="_abstract"] To safeguard registration against bots, {project_name} has integration with Google reCAPTCHA. @@ -11,26 +11,33 @@ To safeguard registration against bots, {project_name} has integration with Goog Once reCAPTCHA is enabled, you can edit `register.ftl` in your login theme to configure the placement and styling of the reCAPTCHA button on the registration page. .Procedure -. Navigate to the link:https://developers.google.com/recaptcha/[Google Recaptcha website]. +. Enter the following URL in a browser: +---- +https://developers.google.com/recaptcha/ +---- . Create an API key to get your reCAPTCHA site key and secret. Note the reCAPTCHA site key and secret for future use in this procedure. + NOTE: The localhost works by default. You do not have to specify a domain. + . Navigate to the {project_name} admin console. -. Click *Authentication* in the left menu. +. Click *Authentication* in the main menu. . Click the *Flows* tab. . Select *Registration* from the drop down menu. -. Set the *reCAPTCHA* requirement to *Required* by clicking the appropriate radio button. This enables +. Set the *reCAPTCHA* requirement to *Required*. This enables reCAPTCHA. . Click *Actions* to the right of the reCAPTCHA flow entry. -. Click the *Config* link to redirect to the config page. -. Enter the reCAPTCHA site key generated from the Google reCAPTCHA website, on the config page. -. Enter the secret generated from the Google reCAPTCHA website, on the config page. -. Authorize Google to use the registration page as an iframe. +. Click the *Config* link. The config page is displayed. + -NOTE: {project_name} prevents websites from including a login page dialog in an iframe. This restriction is to prevent clickjacking attacks. You need to change the default HTTP response headers that is set in {project_name}. +.Recaptcha Config Page +image:{project_images}/recaptcha-config.png[] + +.. Enter the reCAPTCHA site key generated from the Google reCAPTCHA website on the config page. +.. Enter the secret generated from the Google reCAPTCHA website. +.. Authorize Google to use the registration page as an iframe. + -.. Click *Realm Settings* in the left menu. +NOTE: In {project_name}, websites cannot include a login page dialog in an iframe. This restriction is to prevent clickjacking attacks. You need to change the default HTTP response headers that is set in {project_name}. ++ +.. Click *Realm Settings* in the main menu. .. Click the *Security Defenses* tab. .. Enter `https://www.google.com` in the field for the *X-Frame-Options* header. .. Enter `https://www.google.com` in the field for the *Content-Security-Policy* header. diff --git a/server_admin/topics/users/proc-enabling-user-registration.adoc b/server_admin/topics/users/proc-enabling-user-registration.adoc index 23671b9e1b..745955d0ca 100644 --- a/server_admin/topics/users/proc-enabling-user-registration.adoc +++ b/server_admin/topics/users/proc-enabling-user-registration.adoc @@ -9,7 +9,7 @@ Enable users to self-register. After you enable this setting, a *Register* link is displayed on the login page of the admin console. .Procedure -. Click *Realm Settings* in the left menu. +. Click *Realm Settings* in the main menu. . Click the *Login* tab. -. Enable the *User Registration* radio button, to turn it on. +. Toggle *User Registration* to *ON*. . Click *Save*. diff --git a/server_admin/topics/users/proc-registering-new-user.adoc b/server_admin/topics/users/proc-registering-new-user.adoc index 6b1a2c041c..2f90141c8d 100644 --- a/server_admin/topics/users/proc-registering-new-user.adoc +++ b/server_admin/topics/users/proc-registering-new-user.adoc @@ -15,7 +15,7 @@ image:{project_images}/registration-form.png[] * User registration is enabled. .Procedure -. Click the *Register* link on the login page. You are directed to the registration page. +. Click the *Register* link on the login page. The registration page is displayed. . 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 a71b5bb546..99980c19ea 100644 --- a/server_admin/topics/users/proc-searching-user.adoc +++ b/server_admin/topics/users/proc-searching-user.adoc @@ -11,7 +11,7 @@ Search for a user to view detailed information about the user, such as the user' * You are in the realm where the user exists. .Procedure -. Click *Users* in the left menu. This opens the user list page. +. Click *Users* in the main menu. This opens the user list page. . Type the full name, last name, first name, or email address of the user you want to search for in the search box. The search returns all users that match your criteria. . Alternatively, you can click *View all users* to list every user in the system. + 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 5136e41a55..4f84dde1d9 100644 --- a/server_admin/topics/users/proc-setting-default-required-actions.adoc +++ b/server_admin/topics/users/proc-setting-default-required-actions.adoc @@ -17,6 +17,6 @@ can use the user registration link or the *Required Actions* tab. . Specify the default required actions. .Using the Required Actions tab -. Click *Authentication* in the left menu. +. Click *Authentication* in the menu. . Click the *Required Actions* tab. . Click the checkbox in the *Default Action* column for one or more required actions. When a new user logs in for the first time, the selected actions must be executed. \ No newline at end of file diff --git a/server_admin/topics/users/proc-setting-password-user.adoc b/server_admin/topics/users/proc-setting-password-user.adoc index 8cda83e05f..b630d8226b 100644 --- a/server_admin/topics/users/proc-setting-password-user.adoc +++ b/server_admin/topics/users/proc-setting-password-user.adoc @@ -11,6 +11,8 @@ If a user does not have a password, or if the password has been deleted, the *Se If a user already has a password, it can be reset in the *Reset Password* section. .Procedure +. Click *Users* in the menu. The user list page is displayed. +. Select a user. . Type a new password, in the *Set Password* section. . Click *Set Password*. + diff --git a/server_admin/topics/users/proc-setting-required-actions.adoc b/server_admin/topics/users/proc-setting-required-actions.adoc index 35e973d82f..610a1e7500 100644 --- a/server_admin/topics/users/proc-setting-required-actions.adoc +++ b/server_admin/topics/users/proc-setting-required-actions.adoc @@ -8,7 +8,7 @@ You can set the actions that are required for any user. .Procedure -. Click *Users* in the left column. +. Click *Users* in the menu. . Select a user from the list. . Navigate to the *Required User Actions* list. +