update content with corrections (#42)
* update content with corrections * updates
This commit is contained in:
parent
50caba8e2e
commit
fef494fc30
15 changed files with 63 additions and 45 deletions
|
@ -1,18 +1,28 @@
|
||||||
|
|
||||||
== Managing Users
|
== 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-searching-user.adoc[leveloffset=+2]
|
||||||
include::users/proc-creating-user.adoc[leveloffset=2]
|
include::users/proc-creating-user.adoc[leveloffset=+2]
|
||||||
include::users/proc-deleting-user.adoc[leveloffset=2]
|
include::users/proc-deleting-user.adoc[leveloffset=+2]
|
||||||
include::users/proc-configuring-user-attributes.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/ref-user-credentials.adoc[leveloffset=+2]
|
||||||
include::users/proc-creating-otp.adoc[leveloffset=3]
|
include::users/proc-setting-password-user.adoc[leveloffset=+3]
|
||||||
include::users/con-required-actions.adoc[leveloffset=2]
|
include::users/proc-creating-otp.adoc[leveloffset=+3]
|
||||||
include::users/con-user-impersonation.adoc[leveloffset=2]
|
|
||||||
include::users/con-user-registration.adoc[leveloffset=2]
|
include::users/con-required-actions.adoc[leveloffset=+2]
|
||||||
include::users/proc-enabling-recaptcha-support.adoc[leveloffset=2]
|
include::proc-setting-required-actions.adoc[leveloffset=+3]
|
||||||
include::users/ref-personal-data-collected.adoc[leveloffset=2]
|
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]
|
||||||
|
|
||||||
|
|
|
@ -24,6 +24,4 @@ Update Profile::
|
||||||
The user must update profile information, such as name, address, email, and phone number.
|
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]
|
|
||||||
|
|
|
@ -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 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.
|
* 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.
|
You can access the *Impersonate* button from the *Details* tab on the *Users* page.
|
||||||
|
|
||||||
|
|
|
@ -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.
|
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"]
|
[role="_additional-resources"]
|
||||||
.Additional resources
|
.Additional resources
|
||||||
|
|
|
@ -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.
|
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
|
.Prerequisite
|
||||||
* You are in the realm where the user exists.
|
* You are in the realm where the user exists.
|
||||||
|
|
||||||
.Procedure
|
.Procedure
|
||||||
. Click *Users* in the left menu.
|
. Click *Users* in the menu.
|
||||||
. Select a user to manage.
|
. Select a user to manage.
|
||||||
. Click the *Attributes* tab.
|
. Click the *Attributes* tab.
|
||||||
. Enter the attribute name in the *Key* field.
|
. Enter the attribute name in the *Key* field.
|
||||||
|
|
|
@ -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.
|
* You are logged in to the appropriate realm.
|
||||||
|
|
||||||
.Procedure
|
.Procedure
|
||||||
|
. Click *Users* in the main menu. The user list page is displayed.
|
||||||
|
. Select a user.
|
||||||
. Navigate to the *Reset Actions* list.
|
. Navigate to the *Reset Actions* list.
|
||||||
. Click *Configure OTP*.
|
. Click *Configure OTP*.
|
||||||
. Click *Send Email*. The sent email contains a link that directs the user to the OTP setup page.
|
. Click *Send Email*. The sent email contains a link that directs the user to the OTP setup page.
|
||||||
|
|
|
@ -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.
|
* You are in a realm other than the master realm.
|
||||||
|
|
||||||
.Procedure
|
.Procedure
|
||||||
. In the admin console, click *Users* in the left menu.
|
. Click *Users* in the menu.
|
||||||
. Click *Add User* on the right side of the empty user list.
|
. Click *Add User*.
|
||||||
. Enter the details for the new user.
|
. Enter the details for the new user.
|
||||||
|
|
||||||
ifdef::standalone[]
|
ifdef::standalone[]
|
||||||
|
@ -24,10 +24,10 @@ NOTE: *Username* is the only required field.
|
||||||
endif::[]
|
endif::[]
|
||||||
|
|
||||||
ifdef::api-management[]
|
ifdef::api-management[]
|
||||||
. Set *Email Verified* to *ON*.
|
. Toggle *Email Verified* to *ON*.
|
||||||
. Click *Save*.
|
. Click *Save*.
|
||||||
. In the *Credentials* tab, set the password in both fields.
|
. 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 *Reset Password*.
|
||||||
.. Click *Change Password*.
|
.. Click *Change Password*.
|
||||||
.. Click *Save*.
|
.. Click *Save*.
|
||||||
|
|
|
@ -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.
|
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
|
.Procedure
|
||||||
. Click on *Users* in the left menu. This action opens the user list page.
|
. Click on *Users* in the menu. The user list page is displayed.
|
||||||
. Click *View all users* to find the user to delete.
|
. Click *View all users* to find a user to delete.
|
||||||
+
|
+
|
||||||
NOTE: Alternatively, you can use the search bar to find a user.
|
NOTE: Alternatively, you can use the search bar to find a user.
|
||||||
+
|
+
|
||||||
|
|
|
@ -2,8 +2,8 @@
|
||||||
//
|
//
|
||||||
// server_admin/topics/users.adoc
|
// server_admin/topics/users.adoc
|
||||||
|
|
||||||
[id="proc-enabling-recaptcha-support_{context}"]
|
[id="proc-enabling-recaptcha_{context}"]
|
||||||
= Enabling reCAPTCHA Support
|
= Enabling reCAPTCHA
|
||||||
|
|
||||||
[role="_abstract"]
|
[role="_abstract"]
|
||||||
To safeguard registration against bots, {project_name} has integration with Google reCAPTCHA.
|
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.
|
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
|
.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.
|
. 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.
|
NOTE: The localhost works by default. You do not have to specify a domain.
|
||||||
+
|
+
|
||||||
. Navigate to the {project_name} admin console.
|
. Navigate to the {project_name} admin console.
|
||||||
. Click *Authentication* in the left menu.
|
. Click *Authentication* in the main menu.
|
||||||
. Click the *Flows* tab.
|
. Click the *Flows* tab.
|
||||||
. Select *Registration* from the drop down menu.
|
. 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.
|
reCAPTCHA.
|
||||||
. Click *Actions* to the right of the reCAPTCHA flow entry.
|
. Click *Actions* to the right of the reCAPTCHA flow entry.
|
||||||
. Click the *Config* link to redirect to the config page.
|
. Click the *Config* link. The config page is displayed.
|
||||||
. 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.
|
|
||||||
+
|
+
|
||||||
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.
|
.. 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 *X-Frame-Options* header.
|
||||||
.. Enter `https://www.google.com` in the field for the *Content-Security-Policy* header.
|
.. Enter `https://www.google.com` in the field for the *Content-Security-Policy* header.
|
|
@ -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.
|
Enable users to self-register. After you enable this setting, a *Register* link is displayed on the login page of the admin console.
|
||||||
|
|
||||||
.Procedure
|
.Procedure
|
||||||
. Click *Realm Settings* in the left menu.
|
. Click *Realm Settings* in the main menu.
|
||||||
. Click the *Login* tab.
|
. Click the *Login* tab.
|
||||||
. Enable the *User Registration* radio button, to turn it on.
|
. Toggle *User Registration* to *ON*.
|
||||||
. Click *Save*.
|
. Click *Save*.
|
||||||
|
|
|
@ -15,7 +15,7 @@ image:{project_images}/registration-form.png[]
|
||||||
* User registration is enabled.
|
* User registration is enabled.
|
||||||
|
|
||||||
.Procedure
|
.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 user profile information.
|
||||||
. Enter the new password.
|
. Enter the new password.
|
||||||
. Click *Save*.
|
. Click *Save*.
|
||||||
|
|
|
@ -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.
|
* You are in the realm where the user exists.
|
||||||
|
|
||||||
.Procedure
|
.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.
|
. 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.
|
. Alternatively, you can click *View all users* to list every user in the system.
|
||||||
+
|
+
|
||||||
|
|
|
@ -17,6 +17,6 @@ can use the user registration link or the *Required Actions* tab.
|
||||||
. Specify the default required actions.
|
. Specify the default required actions.
|
||||||
|
|
||||||
.Using the Required Actions tab
|
.Using the Required Actions tab
|
||||||
. Click *Authentication* in the left menu.
|
. Click *Authentication* in the menu.
|
||||||
. Click the *Required Actions* tab.
|
. 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.
|
. 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.
|
|
@ -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.
|
If a user already has a password, it can be reset in the *Reset Password* section.
|
||||||
|
|
||||||
.Procedure
|
.Procedure
|
||||||
|
. Click *Users* in the menu. The user list page is displayed.
|
||||||
|
. Select a user.
|
||||||
. Type a new password, in the *Set Password* section.
|
. Type a new password, in the *Set Password* section.
|
||||||
. Click *Set Password*.
|
. Click *Set Password*.
|
||||||
+
|
+
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
You can set the actions that are required for any user.
|
You can set the actions that are required for any user.
|
||||||
|
|
||||||
.Procedure
|
.Procedure
|
||||||
. Click *Users* in the left column.
|
. Click *Users* in the menu.
|
||||||
. Select a user from the list.
|
. Select a user from the list.
|
||||||
. Navigate to the *Required User Actions* list.
|
. Navigate to the *Required User Actions* list.
|
||||||
+
|
+
|
||||||
|
|
Loading…
Reference in a new issue