diff --git a/SUMMARY.adoc b/SUMMARY.adoc index d6c18f0381..475cefdc40 100755 --- a/SUMMARY.adoc +++ b/SUMMARY.adoc @@ -22,12 +22,12 @@ .. link:topics/users/create-user.adoc[Creating New Users] .. link:topics/users/attributes.adoc[User Attributes] .. link:topics/users/credentials.adoc[Credentials] + .. link:topics/users/required-actions.adoc[Required Actions] . link:topics/admin-permissions.adoc[Master Admin Access Control] . link:topics/per-realm-admin-permissions.adoc[Per Realm Admin Access Control] . link:topics/client-registration.adoc[Client Registration] . link:topics/identity-broker.adoc[Identity Broker] . link:topics/recaptcha.adoc[Recaptcha Support on Registration] - . link:topics/email.adoc[Email] . link:topics/access-types.adoc[Client Access Types] . link:topics/roles.adoc[Roles] . link:topics/groups.adoc[Groups] diff --git a/keycloak-images/default-required-actions.png b/keycloak-images/default-required-actions.png new file mode 100644 index 0000000000..8d7b8c8b48 Binary files /dev/null and b/keycloak-images/default-required-actions.png differ diff --git a/keycloak-images/user-required-action.png b/keycloak-images/user-required-action.png new file mode 100644 index 0000000000..22ed250546 Binary files /dev/null and b/keycloak-images/user-required-action.png differ diff --git a/rhsso-images/default-required-actions.png b/rhsso-images/default-required-actions.png new file mode 100644 index 0000000000..80c485205c Binary files /dev/null and b/rhsso-images/default-required-actions.png differ diff --git a/rhsso-images/user-required-action.png b/rhsso-images/user-required-action.png new file mode 100644 index 0000000000..ecaca6bd36 Binary files /dev/null and b/rhsso-images/user-required-action.png differ diff --git a/topics/users/required-actions.adoc b/topics/users/required-actions.adoc new file mode 100644 index 0000000000..b756a101db --- /dev/null +++ b/topics/users/required-actions.adoc @@ -0,0 +1,44 @@ + +=== Required Actions + +Required Actions are tasks that a user must finish before they are allowed to log in. A user must enter +in their credentials before required actions are executed. Once a required action is completed, the user will not have +to perform the action again. +Here are an explanation of some of the built in required action types: + +Update Password:: + When set, a user must change their password. +Configure OTP:: + When set, a user must configure a one-time password generator on their mobile device using either the Free OTP or Google Authenticator appliation. +Verify Email:: + When set, a user must verify that they have a valid email account. An email will be sent to the user with a link they have to click. Once this workflow + is successfully completed, they will be allowed to log in. +Update Profile:: + This required action asks the user to update their profile information, i.e. their name, address, email, and/or phone number. + +Admins can set add required actions for each individual user with the user's `Details` tab in the Admin Console. + +.Setting Required Action +image:../../{{book.images}}/user-required-action.png[] + +In the `Required User Actions` list box, select all the actions you want to add to the account. If you want to remove one, click the `X` next to the +action name. Also remember to click the `Save` button after you've decided what actions to add. + +==== Default Required Actions + +You can also specify required actions that will be added to an account whenever a new user is created, i.e. through the `Add User` button the user +list screen, or via the <> link on the login page. To specify +the default required actions go to the `Authentication` left menu item and click on the `Required Actions` tab. + +.Default Required Actions +image:../../{{book.images}}/default-required-actions.png[] + +Simple click the checkbox in the `Default Action` column of the required actions that you want to be executed when a brand new user logs in. + +==== Terms and Conditions + +Many organizations have a requirement that when a new user logs in for the first time, they need to agree to the terms and conditions +of the website. {{book.project.name}} has this functionality implemented as a required action, but it requires some configuration. For one, you +have to go to the `Required Actions` tab described earlier and enable the `Terms and Conditions` action. You must also edit the +_terms.ftl_ file in the _base_ login theme. See the link:{{book.developerguide.link}}[{{book.developerguide.name}}] for more information on extending and +creating themes.