diff --git a/site/docs/administrate/02-organisations.en.md b/site/docs/administrate/02-organisations.en.md index 00e8d2e1a3..f569b57b31 100644 --- a/site/docs/administrate/02-organisations.en.md +++ b/site/docs/administrate/02-organisations.en.md @@ -34,7 +34,33 @@ Once you created your organisation you will receive a generated domain name from After the domain is verified your users can use both domain names to log-in. The user "coyote" can now use "coyote@acme.zitadel.ch" and "coyote@acme.ch". An organisation can have multiple domain names, but only one of it can be primary. The primary domain defines which login name ZITADEL displays to the user, and also what information gets asserted in access_tokens (preferred_username). -> Screenshot here +Browse to your [organisation](administrate#Organisations) by visiting [https://console.zitadel.ch/org](https://console.zitadel.ch/org). + +Add the domain to your [organisation](administrate#Organisations) by clicking the button **Add Domain**. +Organisation Overview + +Input the domain in the input field and click **Add** +Organisation Add Domain + +Organisation Domain Added + +To start the domain verification click the domain name and a dialog will appear, where you can choose between DNS or HTTP challenge methods. +Organisation Domain Verify + +For example, create a TXT record with your DNS provider for the used domain an click verify. **ZITADEL** will then proceed an check your DNS. +Organisation Domain Verify DNS + +> Do not delete the verification code **ZITADEL** will recheck the ownership from time to time + +When the verification is successful you have the option to activate the domain by clicking **Set as primary** +Organisation Domain Verified + +> This changes the **preferred loginnames** of your [users](administrate#Users) as indicated [here](administrate#How_ZITADEL_handles_usernames). + +Gratulations your are done! You can check this by visiting [https://console.zitadel.ch/users/me](https://console.zitadel.ch/users/me) +User Personal Information + +> This only works when the [user](administrate#Users) is member of this [organisation](administrate#Organisations) ### Audit organisation changes diff --git a/site/docs/administrate/03-projects.en.md b/site/docs/administrate/03-projects.en.md index 0c3345ff81..3e2d4fe7f1 100644 --- a/site/docs/administrate/03-projects.en.md +++ b/site/docs/administrate/03-projects.en.md @@ -38,7 +38,15 @@ To make it more easily to differentiate ZITADEL Console displays these both as s ### Manage a project -> Screenshot here +#### Create a project + +To create your project go to [https://console.zitadel.ch/projects](https://console.zitadel.ch/projects) + +Manage Projects + +Create a new project with name which explains what's the intended use of this project. + +Manage Projects #### RBAC Settings diff --git a/site/docs/administrate/04-clients.en.md b/site/docs/administrate/04-clients.en.md index 6372e72c71..cf23d639e5 100644 --- a/site/docs/administrate/04-clients.en.md +++ b/site/docs/administrate/04-clients.en.md @@ -11,12 +11,31 @@ For example you could have a software project existing out of a web app and a mo Clients might use different protocols for integrating with an IAM. With ZITADEL it is possible to use OpenID Connect 1.0 / OAuth 2.0. In the future SAML 2.0 support is planned as well. -> Screenshot here +#### OIDC Configuration -### Configure OpenID Connect 1.0 Client +> Document Settings + +### Create a client To make configuration of a client easy we provide a wizard which generates a specification conferment setup. The wizard can be skipped for people who are needing special settings. -For use cases where your configuration is not compliant we provide you a "dev mode" which disables conformance checks. -> Screenshot here +> For use cases where your configuration is not compliant we provide you a "dev mode" which disables conformance checks. + +To create a new client start by browsing to your [project](administrate#Projects), this is normally something like [https://console.zitadel.ch/projects/78562301657017889](https://console.zitadel.ch/projects/78562301657017889) + +Manage Clients + +Click the **New** button and a wizard will appear which will guide you through the process. + +Client Wizard + +Client Wizard + +Client Wizard + +Client Wizard + +When the wizard is complete, the clients configuration will be displayed and you can now use this client. + +Client Wizard \ No newline at end of file diff --git a/site/docs/administrate/06-users.en.md b/site/docs/administrate/06-users.en.md index 3d3ec97d69..9f73952792 100644 --- a/site/docs/administrate/06-users.en.md +++ b/site/docs/administrate/06-users.en.md @@ -4,32 +4,48 @@ title: Users ### What are users -In ZITADEL there are different users. Some belong to dedicated organisations other belong to the global org. Some of them are human users others are machines. -Nonetheless we treat them all the same in regard to roles management and audit trail. +In **ZITADEL** there are different [users](administrate#Users). Some belong to dedicated [organisations](administrate#Organisations) other belong to the global [organisations](administrate#Organisations). Some of them are human [users](administrate#Users) others are machines. +Nonetheless we treat them all the same in regard to [roles](administrate#Roles) management and audit trail. #### Human vs. Service Users -The major difference between humane vs. machine users is the type of credentials who can be used. -With machine users there is only a non interactive login process possible. As such we utilize “JWT as Authorization Grant”. +The major difference between humane vs. machine [users](administrate#Users) is the type of credentials who can be used. +With machine [users](administrate#Users) there is only a non interactive login process possible. As such we utilize “JWT as Authorization Grant”. > TODO Link to “JWT as Authorization Grant” explanation. ### How ZITADEL handles usernames -ZITADEL is built around the concept of organisations. Each organisation has it's own pool of usernames which include human and service users. -For example a user with the username `alice` can only exist once the org. `ACME`. ZITADEL will automatically generate a "logonname" for each user consisting of `{username}@{domainname}.{zitadeldomain}`. Without verifying the domain name this would result in the logonname `alice@acme.zitadel.ch`. If you use a dedicated ZITADEL replace `zitadel.ch` with your domain name. +**ZITADEL** is built around the concept of [organisations](administrate#Organisations). Each [organisation](administrate#Organisations) has it's own pool of usernames which include human and service [users](administrate#Users). +For example a [user](administrate#Users) with the username `road.runner` can only exist once the [organisation](administrate#Organisations) `ACME`. **ZITADEL** will automatically generate a "logonname" for each [user](administrate#Users) consisting of `{username}@{domainname}.{zitadeldomain}`. Without verifying the domain name this would result in the logonname `road.runner@acme.zitadel.ch`. If you use a dedicated **ZITADEL** replace `zitadel.ch` with your domain name. -If someone verifies a domain name within the org. ZITADEL will generate additional logonames for each user with that domain. For example if the domain is `acme.ch` the resulting logonname would be `alice@acme.ch` and as well the generated one `alice@acme.zitadel.ch`. +If someone verifies a domain name within the organisation **ZITADEL** will generate additional logonames for each [user](administrate#Users) with that domain. For example if the domain is `acme.ch` the resulting logonname would be `road.runner@acme.ch` and as well the generated one `road.runner@acme.zitadel.ch`. -> Domain verification also removes the logonname from all users who might have used this combination in the global org. -> Relating to example with `acme.ch` if a user in the global org, let's call him `bob` used `bob@acme.ch` this logonname will be replaced with `bob@randomvalue.tld` -> ZITADEL notifies the user about this change +> Domain verification also removes the logonname from all [users](administrate#Users who might have used this combination in the global [organisation](administrate#Organisations). +> Relating to example with `acme.ch` if a user in the global [organisation](administrate#Organisations), let's call him `coyote` used `coyote@acme.ch` this logonname will be replaced with `coyote@randomvalue.tld` +> **ZITADEL** notifies the user about this change ### Manage Users -#### Create User +#### Search Users -> Screenshot here +User list Search + +Image 1: User List Search + +#### Create Users + +User list + +Image 2: User List + +User Create Form + +Image 3: User Create Form + +User Create Done + +Image 4: User Create Done #### Set Password diff --git a/site/docs/start/00-quick-start.en.md b/site/docs/start/00-quick-start.en.md index 18bc510719..3ca8c2c7c5 100644 --- a/site/docs/start/00-quick-start.en.md +++ b/site/docs/start/00-quick-start.en.md @@ -7,19 +7,33 @@ description: A quick-start reference for the impatient reader. ### Try ZITADEL -You can either use [ZITADEL.ch](https://zitadel.ch) or deploy a dedicated ZITADEL instance. +You can either use [ZITADEL.ch](https://zitadel.ch) or deploy a dedicated **ZITADEL** instance. ### Use ZITADEL.ch -To register your free organisation, visit this link [register organisation](https://accounts.zitadel.ch/register/org). -After accepting the TOS and filling out all the required fields you will receive a mail with further instructions. +To register your free [organisation](administrate#Organisations), visit this link [register organisation](https://accounts.zitadel.ch/register/org). +After accepting the TOS and filling out all the required fields you will receive a email with further instructions. + +Organisation Register #### Verify your domain name (optional) +When you verify your domain you get the benefit that your [organisations](administrate#Organisations) [users](administrate#Users) can use this domain as **preferred loginname**. You find a more detailed explanation [How ZITADEL handles usernames](administrate#How_ZITADEL_handles_usernames). + +The verification process is documented [here](administrate#Verify_a_domain_name) + #### Add Users to your organisation +To add new user just follow [this guide](administrate#Create_Users) + #### Setup an application +First [create a project](administrate#Create_a_project) + +Then create within this [project](administrate#Projects) a [new client](administrate#Create_a_client) + +The wizard should provide some guidance what client is the proper for you. If you are still unsure consult our [Integration Guide](integrate#Overview) + ### Use ORBOS to install ZITADEL > This will be added later on diff --git a/site/docs/use/00-user.en.md b/site/docs/use/00-user.en.md index 482d1d4a98..a14d4ddf12 100644 --- a/site/docs/use/00-user.en.md +++ b/site/docs/use/00-user.en.md @@ -19,3 +19,17 @@ title: User Manual #### Auto Register #### Manage Account Linking + +### Login User + +Login Username + +Image: Login Username + +Login Password + +Image: Login Password + +Login OTP + +Image: Login OTP diff --git a/site/static/img/accounts_org_register.png b/site/static/img/accounts_org_register.png new file mode 100644 index 0000000000..bb7b2f77d9 Binary files /dev/null and b/site/static/img/accounts_org_register.png differ diff --git a/site/static/img/accounts_otp_select.png b/site/static/img/accounts_otp_select.png new file mode 100644 index 0000000000..58f604ef3d Binary files /dev/null and b/site/static/img/accounts_otp_select.png differ diff --git a/site/static/img/accounts_otp_setup.png b/site/static/img/accounts_otp_setup.png new file mode 100644 index 0000000000..85d6fb1b04 Binary files /dev/null and b/site/static/img/accounts_otp_setup.png differ diff --git a/site/static/img/accounts_otp_setup_done.png b/site/static/img/accounts_otp_setup_done.png new file mode 100644 index 0000000000..09292f9209 Binary files /dev/null and b/site/static/img/accounts_otp_setup_done.png differ diff --git a/site/static/img/accounts_otp_verify.png b/site/static/img/accounts_otp_verify.png new file mode 100644 index 0000000000..2f037e82b6 Binary files /dev/null and b/site/static/img/accounts_otp_verify.png differ diff --git a/site/static/img/accounts_page.png b/site/static/img/accounts_page.png new file mode 100644 index 0000000000..a9258bf33f Binary files /dev/null and b/site/static/img/accounts_page.png differ diff --git a/site/static/img/accounts_password.png b/site/static/img/accounts_password.png new file mode 100644 index 0000000000..a1423ba5ee Binary files /dev/null and b/site/static/img/accounts_password.png differ diff --git a/site/static/img/accounts_verify_code_password.png b/site/static/img/accounts_verify_code_password.png new file mode 100644 index 0000000000..1351f5ba89 Binary files /dev/null and b/site/static/img/accounts_verify_code_password.png differ diff --git a/site/static/img/accounts_verify_code_password_done.png b/site/static/img/accounts_verify_code_password_done.png new file mode 100644 index 0000000000..cf64ede5b1 Binary files /dev/null and b/site/static/img/accounts_verify_code_password_done.png differ diff --git a/site/static/img/console_clients_my_first_spa_config.png b/site/static/img/console_clients_my_first_spa_config.png new file mode 100644 index 0000000000..281b84b208 Binary files /dev/null and b/site/static/img/console_clients_my_first_spa_config.png differ diff --git a/site/static/img/console_clients_my_first_spa_wizard_1.png b/site/static/img/console_clients_my_first_spa_wizard_1.png new file mode 100644 index 0000000000..5745a18b26 Binary files /dev/null and b/site/static/img/console_clients_my_first_spa_wizard_1.png differ diff --git a/site/static/img/console_clients_my_first_spa_wizard_2.png b/site/static/img/console_clients_my_first_spa_wizard_2.png new file mode 100644 index 0000000000..1df0c0c57a Binary files /dev/null and b/site/static/img/console_clients_my_first_spa_wizard_2.png differ diff --git a/site/static/img/console_clients_my_first_spa_wizard_3.png b/site/static/img/console_clients_my_first_spa_wizard_3.png new file mode 100644 index 0000000000..e5d6009e70 Binary files /dev/null and b/site/static/img/console_clients_my_first_spa_wizard_3.png differ diff --git a/site/static/img/console_clients_my_first_spa_wizard_4.png b/site/static/img/console_clients_my_first_spa_wizard_4.png new file mode 100644 index 0000000000..072bb1bba8 Binary files /dev/null and b/site/static/img/console_clients_my_first_spa_wizard_4.png differ diff --git a/site/static/img/console_org_domain.png b/site/static/img/console_org_domain.png new file mode 100644 index 0000000000..973ed69cef Binary files /dev/null and b/site/static/img/console_org_domain.png differ diff --git a/site/static/img/console_org_domain_add.png b/site/static/img/console_org_domain_add.png new file mode 100644 index 0000000000..96e5f9102c Binary files /dev/null and b/site/static/img/console_org_domain_add.png differ diff --git a/site/static/img/console_org_domain_added.png b/site/static/img/console_org_domain_added.png new file mode 100644 index 0000000000..ba5b117bc6 Binary files /dev/null and b/site/static/img/console_org_domain_added.png differ diff --git a/site/static/img/console_org_domain_default.png b/site/static/img/console_org_domain_default.png new file mode 100644 index 0000000000..e745955864 Binary files /dev/null and b/site/static/img/console_org_domain_default.png differ diff --git a/site/static/img/console_org_domain_primary.png b/site/static/img/console_org_domain_primary.png new file mode 100644 index 0000000000..4d32356330 Binary files /dev/null and b/site/static/img/console_org_domain_primary.png differ diff --git a/site/static/img/console_org_domain_verified.png b/site/static/img/console_org_domain_verified.png new file mode 100644 index 0000000000..a217f6b398 Binary files /dev/null and b/site/static/img/console_org_domain_verified.png differ diff --git a/site/static/img/console_org_domain_verify.png b/site/static/img/console_org_domain_verify.png new file mode 100644 index 0000000000..973ed69cef Binary files /dev/null and b/site/static/img/console_org_domain_verify.png differ diff --git a/site/static/img/console_org_domain_verify_dns.png b/site/static/img/console_org_domain_verify_dns.png new file mode 100644 index 0000000000..03dee5d4c8 Binary files /dev/null and b/site/static/img/console_org_domain_verify_dns.png differ diff --git a/site/static/img/console_personal_information.png b/site/static/img/console_personal_information.png new file mode 100644 index 0000000000..92bd397373 Binary files /dev/null and b/site/static/img/console_personal_information.png differ diff --git a/site/static/img/console_personal_information_org_owner.png b/site/static/img/console_personal_information_org_owner.png new file mode 100644 index 0000000000..a5a6499e6c Binary files /dev/null and b/site/static/img/console_personal_information_org_owner.png differ diff --git a/site/static/img/console_projects_empty.png b/site/static/img/console_projects_empty.png new file mode 100644 index 0000000000..b628e0ec2f Binary files /dev/null and b/site/static/img/console_projects_empty.png differ diff --git a/site/static/img/console_projects_my_first_project.png b/site/static/img/console_projects_my_first_project.png new file mode 100644 index 0000000000..6c871f95c7 Binary files /dev/null and b/site/static/img/console_projects_my_first_project.png differ diff --git a/site/static/img/console_user_create_done.png b/site/static/img/console_user_create_done.png new file mode 100644 index 0000000000..ccaf7bba1e Binary files /dev/null and b/site/static/img/console_user_create_done.png differ diff --git a/site/static/img/console_user_create_form.png b/site/static/img/console_user_create_form.png new file mode 100644 index 0000000000..12905a0356 Binary files /dev/null and b/site/static/img/console_user_create_form.png differ diff --git a/site/static/img/console_user_list.png b/site/static/img/console_user_list.png new file mode 100644 index 0000000000..debba16db0 Binary files /dev/null and b/site/static/img/console_user_list.png differ diff --git a/site/static/img/console_user_list_search.png b/site/static/img/console_user_list_search.png new file mode 100644 index 0000000000..0f92171183 Binary files /dev/null and b/site/static/img/console_user_list_search.png differ diff --git a/site/static/img/console_user_personal_info.png b/site/static/img/console_user_personal_info.png new file mode 100644 index 0000000000..3ac63d34ca Binary files /dev/null and b/site/static/img/console_user_personal_info.png differ