fix: added user manual videos and description (#1581)
* added user manual videos and description * feat(added manual and videos): manual and videos * added selfregistration * Update site/docs/use/00-user.md Co-authored-by: Fabi <38692350+fgerschwiler@users.noreply.github.com> * Update site/docs/use/00-user.md Co-authored-by: Fabi <38692350+fgerschwiler@users.noreply.github.com> * changed email verification and change email * explained 2fa * changed format * changed video captions * added admin create user * updated screenshots * added selfregister * doc: api descriptions * doc: user manual * doc: user manual * doc: user manual Co-authored-by: Fabi <38692350+fgerschwiler@users.noreply.github.com> Co-authored-by: fabi <fabienne.gerschwiler@gmail.com>
12
docs/docs/manuals/user-email.md
Normal file
@ -0,0 +1,12 @@
|
||||
---
|
||||
title: Email
|
||||
---
|
||||
|
||||
To change your email address visit your Personal Information page and amend the email field.
|
||||
|
||||
|
||||
## Change EMail
|
||||
![Change EMail](/img/change-email.gif)
|
||||
|
||||
## Verify EMail
|
||||
![Verify EMail](/img/email-verify.gif)
|
29
docs/docs/manuals/user-factors.md
Normal file
@ -0,0 +1,29 @@
|
||||
---
|
||||
title: Factors
|
||||
---
|
||||
|
||||
## Manage Multi Factor
|
||||
|
||||
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)
|
||||
|
||||
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.
|
||||
|
||||
> **Information:** Some example Authenticator Apps for OTP are: Google Authenticator, Microsoft Authenticator, Authy. You can choose the one you like the most.
|
||||
|
||||
2. Add U2F (Universal Second Factor)
|
||||
|
||||
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.
|
||||
|
||||
> **Information:** some example Keys are [Solokeys](https://solokeys.com) or [Yubikey](https://www.yubico.com/) You can choose the one you like the most.
|
||||
|
||||
|
||||
|
||||
Enable Multi Factor
|
||||
![Enable Multi Factor](/img/enable-mfa-handling.gif)
|
||||
|
||||
|
||||
Login Multi Factor
|
||||
![Login Multi Factor](/img/login-mfa.gif)
|
14
docs/docs/manuals/user-login.md
Normal file
@ -0,0 +1,14 @@
|
||||
---
|
||||
title: Login
|
||||
---
|
||||
|
||||
## Login Username
|
||||
![Login Username](/img/accounts_page.png)
|
||||
|
||||
|
||||
## Login Password
|
||||
![Login Password](/img/accounts_password.png)
|
||||
|
||||
|
||||
## Login OTP
|
||||
![Login OTP](/img/accounts_multifactor.png)
|
12
docs/docs/manuals/user-password.md
Normal file
@ -0,0 +1,12 @@
|
||||
---
|
||||
title: Password
|
||||
---
|
||||
|
||||
## Change Password
|
||||
|
||||
To change your password you can hit the link right at the overview page. Alternatively you can set it in the "Personal Information" page.
|
||||
|
||||
|
||||
Change Password
|
||||
![Change Password](/img/change-password.gif)
|
||||
|
14
docs/docs/manuals/user-phone.md
Normal file
@ -0,0 +1,14 @@
|
||||
---
|
||||
title: Phone
|
||||
---
|
||||
|
||||
|
||||
## Change Phone
|
||||
|
||||
tbd
|
||||
|
||||
## Verify Phone
|
||||
|
||||
tbd
|
||||
|
||||
## Remove Phone
|
47
docs/docs/manuals/user-register.md
Normal file
@ -0,0 +1,47 @@
|
||||
---
|
||||
title: User Register
|
||||
---
|
||||
|
||||
## Organization and user registration
|
||||
|
||||
Zitadel allows users to register a organization and/or user with just a few steps.
|
||||
|
||||
A. Register an organization
|
||||
|
||||
1. Create an organization
|
||||
2. Verify your email
|
||||
3. Login to Zitadel and manage the organization
|
||||
|
||||
B. Create User
|
||||
1. An administrator can create and manage users within console.
|
||||
|
||||
C. Enable selfregistration for User
|
||||
|
||||
1. Create an organization as above
|
||||
2. Create custom policy
|
||||
3. Enable the "Register allowed" flag in the Login Policy
|
||||
4. Connect your application and add the applications [scope](https://docs.zitadel.ch/architecture/#Custom_Scopes) to the redirect URL.
|
||||
|
||||
This will enable the register option in the login dialog and will register the user within your organization if he does not already have an account.
|
||||
|
||||
Register Organization
|
||||
![Register Organization](/img/register.gif)
|
||||
|
||||
|
||||
Create User
|
||||
![Create User](/img/create-user.gif)
|
||||
|
||||
|
||||
Enable Selfregister
|
||||
![Enable Selfregister](/img/enable-selfregister.gif)
|
||||
|
||||
|
||||
|
||||
## Self Register
|
||||
|
||||
When self registration is enabled, users can register themselfes in the organanization without any administrative effort.
|
||||
|
||||
|
||||
Self Register
|
||||
![Self Register](/img/self-register.gif)
|
||||
|
31
docs/docs/manuals/user-social-login.md
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: Social Login
|
||||
---
|
||||
|
||||
## Identity Linking
|
||||
|
||||
To link an external Identity Provider with a Zitadel Account you have to:
|
||||
|
||||
1. choose your IDP
|
||||
2. Login to your IDP
|
||||
|
||||
you can then either
|
||||
|
||||
1. link the Identity to an existing ZITADEL useraccount
|
||||
2. auto register a new ZITADEL useraccount
|
||||
|
||||
|
||||
Linking Accounts
|
||||
![Linking Accounts](/img/linking-accounts.gif)
|
||||
|
||||
|
||||
|
||||
## Manage Account Linking
|
||||
|
||||
You can manage the linked external IDP Providers within the "Personal Information" Page.
|
||||
|
||||
|
||||
Manage External IDP
|
||||
![Manage External IDP](/img/manage-external-idp.png)
|
||||
|
||||
|
@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Login
|
||||
---
|
@ -4,7 +4,7 @@ module.exports = {
|
||||
{
|
||||
type: 'category',
|
||||
label: 'User',
|
||||
items: ['manuals/user'],
|
||||
items: ['manuals/user-register', 'manuals/user-login', 'manuals/user-password', 'manuals/user-factors', 'manuals/user-email', 'manuals/user-phone', 'manuals/user-social-login', ],
|
||||
collapsed: false,
|
||||
},
|
||||
{
|
||||
|
BIN
docs/static/img/accounts_multifactor.png
vendored
Normal file
After Width: | Height: | Size: 55 KiB |
BIN
docs/static/img/accounts_page.png
vendored
Before Width: | Height: | Size: 194 KiB After Width: | Height: | Size: 59 KiB |
BIN
docs/static/img/accounts_password.png
vendored
Before Width: | Height: | Size: 202 KiB After Width: | Height: | Size: 62 KiB |
BIN
docs/static/img/change-email.gif
vendored
Normal file
After Width: | Height: | Size: 11 MiB |
BIN
docs/static/img/change-password.gif
vendored
Normal file
After Width: | Height: | Size: 5.1 MiB |
BIN
docs/static/img/create-user.gif
vendored
Normal file
After Width: | Height: | Size: 3.6 MiB |
BIN
docs/static/img/email-verify.gif
vendored
Normal file
After Width: | Height: | Size: 2.8 MiB |
BIN
docs/static/img/enable-mfa-handling.gif
vendored
Normal file
After Width: | Height: | Size: 7.8 MiB |
BIN
docs/static/img/enable-selfregister.gif
vendored
Normal file
After Width: | Height: | Size: 5.6 MiB |
BIN
docs/static/img/linking-accounts.gif
vendored
Normal file
After Width: | Height: | Size: 8.2 MiB |
BIN
docs/static/img/login-mfa.gif
vendored
Normal file
After Width: | Height: | Size: 4.7 MiB |
BIN
docs/static/img/manage-external-idp.png
vendored
Normal file
After Width: | Height: | Size: 170 KiB |
BIN
docs/static/img/register.gif
vendored
Normal file
After Width: | Height: | Size: 3.5 MiB |
BIN
docs/static/img/self-register.gif
vendored
Normal file
After Width: | Height: | Size: 4.6 MiB |