2016-05-14 14:48:22 +00:00
2019-12-20 10:12:57 +00:00
[[_user-credentials]]
2016-06-10 11:40:22 +00:00
=== User Credentials
2016-05-14 14:48:22 +00:00
When viewing a user if you go to the `Credentials` tab you can manage a user's credentials.
.Credential Management
2017-08-28 12:50:14 +00:00
image:{project_images}/user-credentials.png[]
2016-05-14 14:48:22 +00:00
2019-11-12 16:32:33 +00:00
The credentials are listed in a table, which has the following fields:
Position::
The arrow buttons in this column allows you to shift the priority of the credential for the user, with the topmost credential having the highest priority.
This priority determines which credential will be shown first to a user in case of a choice during login. The highest priority of those available to the
user will be the one selected.
Type::
This shows the type of the credential, for example `password` or `otp`.
User Label::
This is an assignable label to recognise the credential when presented as a selection option during login. It can be set to any value to describe the
credential.
Data::
This shows the non-confidential technical information about the credential. It is originally hidden, but you can press `Show data...` to reveal it for a
credential.
Actions::
This column has two buttons. `Save` records the value of the User Label, while `Delete` will remove the credential.
==== Creating a Password for the User
2019-11-13 13:10:50 +00:00
If a user doesn't have a password, or if the password has been deleted, the `Set Password` section will be shown on the page.
2019-11-12 16:32:33 +00:00
.Credential Management - Set Password
2019-11-13 15:16:10 +00:00
image:images/user-credentials-set-password.png[]
2019-11-12 16:32:33 +00:00
To create a password for a user, type in a new one. Click on the `Set Password` button after you've typed everything in.
2016-05-14 14:48:22 +00:00
If the `Temporary` switch is on, this new password can only be used once and the user will be asked to change their password after they have
logged in.
2019-11-26 15:16:16 +00:00
If a user already has a password, it can be reset in the `Reset Password` section.
2017-08-28 12:50:14 +00:00
Alternatively, if you have <<_email, email>> set up, you can send an email to the user that asks
2017-05-17 14:20:44 +00:00
them to reset their password. Choose `Update Password` from the `Reset Actions` list box and click `Send Email`. You can optionally
set the validity of the e-mail link which defaults to the one preset in `Tokens` tab in the realm settings.
2016-05-14 14:48:22 +00:00
The sent email contains a link that will bring the user to the update password screen.
2019-11-12 16:32:33 +00:00
Note that a user can only have a single credential of type password.
==== Creating other credentials
You cannot configure other types of credentials for a specific user within the Admin Console. This is the responsibility of the user.
2019-11-26 15:16:16 +00:00
You can only delete credentials for a user on the `Credentials` tab, for example if the user has lost an OTP device, or if a credential
2019-11-12 16:32:33 +00:00
has been compromised.
===== Creating an OTP
2016-05-14 14:48:22 +00:00
2019-11-12 16:32:33 +00:00
If OTP is conditional in your realm, the user will have to go to the User Account Management service to re-configure a new
OTP generator. A user can set up any number of OTP credentials in this manner. If OTP is required, then the user will be asked
to re-configure a new OTP generator when they log in.
2016-05-14 14:48:22 +00:00
Like passwords, you can alternatively send an email to the user that will ask them to reset their OTP generator. Choose
2016-06-06 13:00:18 +00:00
`Configure OTP` in the `Reset Actions` list box and click the `Send Email` button. The sent email
2019-11-12 16:32:33 +00:00
contains a link that will bring the user to the OTP setup screen. You can use this method even if the user already has an OTP credential,
and would like to set up some more.
