docs: user help (#2484)

* feat: loginname projection

* docs: refactor manuals

* fix: passwordless registation

* fix: pr comments

Co-authored-by: Livio Amstutz <livio.a@gmail.com>
This commit is contained in:
Fabi 2021-10-06 13:57:49 +02:00 committed by GitHub
parent b957f58e1e
commit 3004a3825e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 94 additions and 17 deletions

View File

@ -4,4 +4,9 @@ title: Organizations
import OrgDescription from './_org_description.mdx'; import OrgDescription from './_org_description.mdx';
<OrgDescription name="OrgDescription" /> <OrgDescription name="OrgDescription" />
## Global Organization
In each ZITADEL system you will have a Global organization. If a user registers himself and no specific domain is given he will land in the Global organization.
Users in the Global Organization are managed by themselves and not by the organization manager.

View File

@ -5,25 +5,41 @@ title: Factors
## Manage Multi Factor ## Manage Multi Factor
To enable multifactor authentication visit the "Personal Information" page of your account and scroll to the "multifactor authentication". To enable multifactor authentication visit the "Personal Information" page of your account and scroll to the "multifactor authentication".
You can either:
1. Configure OTP (One Time Password) :::caution
In order to avoid being locked out if a factor does not work, we recommend registering several options
:::
An OTP application creates a dynamic Token that changes periodically and needs to be added in addition to the password. Install an aproppriate OTP application of your choice and register Zitadel. The most convenient way is to scan the QR code with your the application on your mobile device. ### Configure OTP (One Time Password)
> **Information:** Some example Authenticator Apps for OTP are: Google Authenticator, Microsoft Authenticator, Authy. You can choose the one you like the most. An OTP application creates a dynamic Token that changes periodically and needs to be added in addition to the password.
1. Install an appropriate OTP application of your choice
2. Click Add AuthFactor
3. Choose OTP Option
4. Scan the QR Code with you chosen authenticator app
5. Enter the code from your app in the ZITADEL Console
2. Add U2F (Universal Second Factor) :::info
Some example Authenticator Apps for OTP are: Google Authenticator, Microsoft Authenticator, Authy. You can choose the one you like the most.
:::
Unuversal Second Factor basically is a piece of hardware such as an USB key that gets linked to your Identity and authorizes as second factor when a button on the device is pressed. ![Add One Time Password](/img/manuals/console_add_otp.gif)
> **Information:** some example Keys are [Solokeys](https://solokeys.com) or [Yubikey](https://www.yubico.com/) You can choose the one you like the most. ### Configure U2F (Universal Second Factor)
U2F is dependent on the device and browser you are currently working.
In general there might be the following possibilities:
- FingerScan
- FaceRecognition (e.g. FaceID)
- Hardware Tokens (e.g. YubiKey, Solokeys)
Hardware Tokens are basically a piece of hardware such as a USB key that gets linked to your Identity and authorizes as second factor when a button on the device is pressed.
:::info
Some example Keys are [Solokeys](https://solokeys.com) or [Yubikey](https://www.yubico.com/) You can choose the one you like the most.
:::
![Add Universal Second Factor](/img/manuals/console_add_u2f.gif)
Enable Multi Factor
![Enable Multi Factor](/img/enable-mfa-handling.gif)
Login Multi Factor
![Login Multi Factor](/img/login-mfa.gif)

View File

@ -3,12 +3,40 @@ title: Login
--- ---
## Login Username ## Login Username
Enter your login name in the input field. Your loginname consists of the username with @ organisation domain. E.g road.runner@acme.caos.ch
If the organization is already pre-selected you do not have to enter the domain.
![Login Username](/img/accounts_page.png) ![Login Username](/img/accounts_page.png)
## Login Password ## Login with Password
Enter you password. If you can't remember it click on the reset password link. You will get an email to set a new passwords.
![Login Password](/img/accounts_password.png) ![Login Password](/img/accounts_password.png)
## Login OTP ## Login with One Time Password (OTP)
If you have registered a One time password (OTP) as a second factor you need to enter your code.
1. Open your authenticator app which you used to set up your OTP
2. Enter the code from the authenticator app in the input field of the login process
![Login OTP](/img/accounts_multifactor.png) ![Login OTP](/img/accounts_multifactor.png)
You can find out how to register OTP [here](./user-factors).
### Can't remember your otp
If you have a problem with your OTP, please contact your organization support. If you have a user in the Global Organization feel free to contact support@zitadel.ch
## Login with Universal Second Factor (U2F) (FaceID, FingerPrint, etc.)
If you have registered U2F as second factor for your account you will have to verify this factor.
1. Click the button "Verify Token"
2. Your browser/device will show you the methods you have to verify your account (e.g FingerScan, Face Recognition, External Hardware Token, etc)
3. Use your verification method
![Login Multi Factor](/img/login-mfa.gif)

View File

@ -0,0 +1,28 @@
---
title: Passwordless
---
## Register Passwordless Authentication
Add passwordless authentication to secure your account.
1. Go to personal information - passwordless authentication
2. Click add authenticator
3. Enter a name for your authentication
4. You have three options to register a new method
- Directly register a new method
- Send a link to your email address
- Generate a QR Code to scan with another device (e.g. Mobile Phone)
5. Directly register a new method
1. Your device/browser will show you the possibilities you have
2. Choose your preferred method
3. Verify your method (e.g. Finger Scan, Face Recognition, Hardware Token, etc..)
:::caution
If you use different browsers, make sure you register all of them, otherwise you will not be able to use passwordless registration everywhere.
This doesn't count for hardware tokens, as these are device independent.
:::
![Add Passwordless](/img/manuals/console_add_passwordless_direct.gif)

View File

@ -235,7 +235,7 @@ module.exports = {
{ {
type: 'category', type: 'category',
label: 'User', label: 'User',
items: ['manuals/user-register', 'manuals/user-login', 'manuals/user-password', 'manuals/user-factors', 'manuals/user-email', 'manuals/user-phone', 'manuals/user-social-login',], items: ['manuals/user-register', 'manuals/user-login', 'manuals/user-passwordless', 'manuals/user-password', 'manuals/user-factors', 'manuals/user-email', 'manuals/user-phone', 'manuals/user-social-login',],
collapsed: false, collapsed: false,
}, },
], ],

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.6 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.2 MiB