diff --git a/docs/docs/manuals/user-email.md b/docs/docs/manuals/user-email.md new file mode 100644 index 0000000000..4dfe109352 --- /dev/null +++ b/docs/docs/manuals/user-email.md @@ -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) diff --git a/docs/docs/manuals/user-factors.md b/docs/docs/manuals/user-factors.md new file mode 100644 index 0000000000..35bf85bc0d --- /dev/null +++ b/docs/docs/manuals/user-factors.md @@ -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) diff --git a/docs/docs/manuals/user-login.md b/docs/docs/manuals/user-login.md new file mode 100644 index 0000000000..578e856a04 --- /dev/null +++ b/docs/docs/manuals/user-login.md @@ -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) diff --git a/docs/docs/manuals/user-password.md b/docs/docs/manuals/user-password.md new file mode 100644 index 0000000000..84aa266106 --- /dev/null +++ b/docs/docs/manuals/user-password.md @@ -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) + diff --git a/docs/docs/manuals/user-phone.md b/docs/docs/manuals/user-phone.md new file mode 100644 index 0000000000..eaffda280c --- /dev/null +++ b/docs/docs/manuals/user-phone.md @@ -0,0 +1,14 @@ +--- +title: Phone +--- + + +## Change Phone + +tbd + +## Verify Phone + +tbd + +## Remove Phone \ No newline at end of file diff --git a/docs/docs/manuals/user-register.md b/docs/docs/manuals/user-register.md new file mode 100644 index 0000000000..918a4c55d8 --- /dev/null +++ b/docs/docs/manuals/user-register.md @@ -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) + diff --git a/docs/docs/manuals/user-social-login.md b/docs/docs/manuals/user-social-login.md new file mode 100644 index 0000000000..f69d15df28 --- /dev/null +++ b/docs/docs/manuals/user-social-login.md @@ -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) + + diff --git a/docs/docs/manuals/user.md b/docs/docs/manuals/user.md deleted file mode 100644 index 87f1965087..0000000000 --- a/docs/docs/manuals/user.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Login ---- diff --git a/docs/sidebars.js b/docs/sidebars.js index b5e8ccb458..f9ecdba394 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -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, }, { diff --git a/docs/static/img/accounts_multifactor.png b/docs/static/img/accounts_multifactor.png new file mode 100644 index 0000000000..dfbc9b2041 Binary files /dev/null and b/docs/static/img/accounts_multifactor.png differ diff --git a/docs/static/img/accounts_page.png b/docs/static/img/accounts_page.png index 52e274b876..43c2a44519 100644 Binary files a/docs/static/img/accounts_page.png and b/docs/static/img/accounts_page.png differ diff --git a/docs/static/img/accounts_password.png b/docs/static/img/accounts_password.png index a7cfb71930..74252e7110 100644 Binary files a/docs/static/img/accounts_password.png and b/docs/static/img/accounts_password.png differ diff --git a/docs/static/img/change-email.gif b/docs/static/img/change-email.gif new file mode 100644 index 0000000000..1bd880c7b7 Binary files /dev/null and b/docs/static/img/change-email.gif differ diff --git a/docs/static/img/change-password.gif b/docs/static/img/change-password.gif new file mode 100644 index 0000000000..f4750ed66d Binary files /dev/null and b/docs/static/img/change-password.gif differ diff --git a/docs/static/img/create-user.gif b/docs/static/img/create-user.gif new file mode 100644 index 0000000000..5a5b63abbf Binary files /dev/null and b/docs/static/img/create-user.gif differ diff --git a/docs/static/img/email-verify.gif b/docs/static/img/email-verify.gif new file mode 100644 index 0000000000..9d4c2d991b Binary files /dev/null and b/docs/static/img/email-verify.gif differ diff --git a/docs/static/img/enable-mfa-handling.gif b/docs/static/img/enable-mfa-handling.gif new file mode 100644 index 0000000000..bb5532c7da Binary files /dev/null and b/docs/static/img/enable-mfa-handling.gif differ diff --git a/docs/static/img/enable-selfregister.gif b/docs/static/img/enable-selfregister.gif new file mode 100644 index 0000000000..91fa2aa5e4 Binary files /dev/null and b/docs/static/img/enable-selfregister.gif differ diff --git a/docs/static/img/linking-accounts.gif b/docs/static/img/linking-accounts.gif new file mode 100644 index 0000000000..fec8160967 Binary files /dev/null and b/docs/static/img/linking-accounts.gif differ diff --git a/docs/static/img/login-mfa.gif b/docs/static/img/login-mfa.gif new file mode 100644 index 0000000000..22024699a2 Binary files /dev/null and b/docs/static/img/login-mfa.gif differ diff --git a/docs/static/img/manage-external-idp.png b/docs/static/img/manage-external-idp.png new file mode 100644 index 0000000000..9c43123d1d Binary files /dev/null and b/docs/static/img/manage-external-idp.png differ diff --git a/docs/static/img/register.gif b/docs/static/img/register.gif new file mode 100644 index 0000000000..3dae01e277 Binary files /dev/null and b/docs/static/img/register.gif differ diff --git a/docs/static/img/self-register.gif b/docs/static/img/self-register.gif new file mode 100644 index 0000000000..383a818d64 Binary files /dev/null and b/docs/static/img/self-register.gif differ