keycloak-scim/server_admin/topics/users/user-registration.adoc

31 lines
1.2 KiB
Text
Raw Normal View History

2016-06-01 02:01:13 +00:00
[[_user-registration]]
2016-05-16 15:17:17 +00:00
== User Registration
2016-05-16 15:17:17 +00:00
2017-08-28 12:50:14 +00:00
You can enable {project_name} to allow user self registration. When enabled, the login page has a registration
2017-12-05 09:59:01 +00:00
link the user can click on to create their new account.
When user self registration is enabled it is possible to use the registration form to detect valid usernames and emails.
2018-08-25 16:57:00 +00:00
It is also possible to enable <<_recaptcha,reCAPTCHA Support>>.
2017-12-05 09:59:01 +00:00
Enabling registration is pretty simple. Go to the
2016-05-16 15:17:17 +00:00
`Realm Settings` left menu and click it. Then go to the `Login` tab. There is a `User Registration` switch on this
tab. Turn it on, then click the `Save` button.
.Login Tab
2017-08-28 12:50:14 +00:00
image:{project_images}/login-tab.png[]
2016-05-16 15:17:17 +00:00
After you enable this setting, a `Register` link should show up on the login page.
.Registration Link
2017-08-28 12:50:14 +00:00
image:{project_images}/registration-link.png[]
2016-05-16 15:17:17 +00:00
Clicking on this link will bring the user to the registration page where they have to enter in some user profile information
and a new password.
.Registration Form
2017-08-28 12:50:14 +00:00
image:{project_images}/registration-form.png[]
2016-05-16 15:17:17 +00:00
You can change the look and feel of the registration form as well as removing or adding additional fields that must be entered.
2018-08-25 16:57:00 +00:00
See the link:{developerguide_link}[{developerguide_name}] for more information.