diff --git a/docs/docs/guides/authentication/authmethods/basic.mdx b/docs/docs/guides/authentication/authmethods/basic.mdx index 5e4d29a6b..be2d1bbd1 100644 --- a/docs/docs/guides/authentication/authmethods/basic.mdx +++ b/docs/docs/guides/authentication/authmethods/basic.mdx @@ -25,7 +25,7 @@ So your request might look like this (linebreaks and whitespace for display reas ```curl curl --request GET \ - --url 'https://accounts.zitadel.ch/oauth/v2/authorize + --url '{your-domain}/oauth/v2/authorize ?client_id=${client_id} &redirect_uri=${redirect_uri} &response_type=code @@ -69,7 +69,7 @@ So check [Client Secret Basic Auth Method](/docs/apis/openidoauth/authn-methods# ```curl curl --request POST \ ---url https://api.zitadel.ch/oauth/v2/token \ +--url {your-domain}/oauth/v2/token \ --header 'Authorization: Basic ${basic}' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data grant_type=authorization_code \ diff --git a/docs/docs/guides/authentication/authmethods/jwtpk.mdx b/docs/docs/guides/authentication/authmethods/jwtpk.mdx index 484c40885..f97ae0a0c 100644 --- a/docs/docs/guides/authentication/authmethods/jwtpk.mdx +++ b/docs/docs/guides/authentication/authmethods/jwtpk.mdx @@ -25,7 +25,7 @@ So your request might look like this (linebreaks and whitespace for display reas ```curl curl --request GET \ - --url 'https://accounts.zitadel.ch/oauth/v2/authorize + --url '{your-domain}/oauth/v2/authorize ?client_id=${client_id} &redirect_uri=${redirect_uri} &response_type=code @@ -69,7 +69,7 @@ for us to validate the signature against the registered public key: ```curl curl --request POST \ ---url https://api.zitadel.ch/oauth/v2/token \ +--url {your-domain}/oauth/v2/token \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data grant_type=authorization_code \ --data code=${code} \ diff --git a/docs/docs/guides/authentication/authmethods/pkce.mdx b/docs/docs/guides/authentication/authmethods/pkce.mdx index b065b9209..544e82caf 100644 --- a/docs/docs/guides/authentication/authmethods/pkce.mdx +++ b/docs/docs/guides/authentication/authmethods/pkce.mdx @@ -33,7 +33,7 @@ The request would finally look like (linebreaks and whitespace for display reaso ```curl curl --request GET \ - --url 'https://accounts.zitadel.ch/oauth/v2/authorize + --url '{your-domain}/oauth/v2/authorize ?client_id=${client_id} &redirect_uri=${redirect_uri} &response_type=code @@ -78,7 +78,7 @@ Send your `client_id` and the previously generated string as `code_verifier` for ```curl curl --request POST \ ---url https://api.zitadel.ch/oauth/v2/token \ +--url {your-domain}/oauth/v2/token \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data grant_type=authorization_code \ --data code=${code} \ diff --git a/docs/docs/guides/authentication/authmethods/pkcenative.mdx b/docs/docs/guides/authentication/authmethods/pkcenative.mdx index 1f9e0c517..e5ea14db0 100644 --- a/docs/docs/guides/authentication/authmethods/pkcenative.mdx +++ b/docs/docs/guides/authentication/authmethods/pkcenative.mdx @@ -53,7 +53,7 @@ Send your `client_id` and the previously generated string as `code_verifier` for ```curl curl --request POST \ ---url https://api.zitadel.ch/oauth/v2/token \ +--url {your-domain}/oauth/v2/token \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data grant_type=authorization_code \ --data code=${code} \ diff --git a/docs/docs/guides/authentication/identity-brokering.md b/docs/docs/guides/authentication/identity-brokering.md index 64264f26e..f62b5473a 100644 --- a/docs/docs/guides/authentication/identity-brokering.md +++ b/docs/docs/guides/authentication/identity-brokering.md @@ -51,8 +51,8 @@ In this exercise we will add a new Google identity provider to federate identiti 1. Register an OIDC Client in your preferred provider 2. Make sure you add the ZITADEL callback redirect uris - https://accounts.zitadel.ch/register/externalidp/callback - https://accounts.zitadel.ch/login/externalidp/callback + - {your-domain}/ui/login/register/externalidp/callback + - {your-domain}/ui/login/login/externalidp/callback > **Information:** Make sure the provider is OIDC 1.0 compliant with a proper Discovery Endpoint @@ -61,7 +61,9 @@ Google Example: 1. Go to the Google Gloud Platform and choose youre project: 2. Click on "+ CREATE CREDENTIALS" and choose "OAuth client ID" 3. Choose Web application as Application type and give a name -4. Add the redirect uris from above +4. Add the redirect uris + - {your-domain}/ui/login/register/externalidp/callback + - {your-domain}/ui/login/login/externalidp/callback 5. Save clientid and client secret ![Add new oAuth credentials in Google Console](/img/google_add_credentials.gif) @@ -71,25 +73,26 @@ Google Example: The login policy can be configured on two levels. Once as default on the instance and this can be overwritten for each organization. This case describes how to change it on the organization. -1. Go to your organization settings by clicking on "Organization" in the menu or using the following link: +1. Go to your organization settings by clicking on "Organization" in the menu 2. Modify your login policy in the menu "Login Behaviour and Security" ![Add custom login policy](/img/console_org_custom_login_policy.gif) -### 3.Configure new identity provider +### 3. Configure new identity provider -1. Go to the identity providers section and click new -2. Fill out the form - - Use the issuer, clientid and client secret provided by your provider +1. Go to the settings of your instance or a specific organization (depending on where you need the identity provider) +2. Go to the identity providers section and click "New" +3. Select "OIDC Configuration" and fill out the form + - Use the issuer, clientid and client secret provided by your provider (Google Issuer: https://accounts.google.com) - The scopes will be prefilled with openid, profile and email, because this information is relevant for ZITADEL - You can choose what fields you like to map as the display name and as username. The fields you can choose are preferred_username and email (Example: For Google you should choose email for both fields) -3. Save your configuration -4. Link your new configuration to your login policy. By searching in the organization category you will get you own configuration. If you choose system you can link all predefined providers. +4. Save your configuration +5. You will now see the created configuration in the list. Click on the activate icon at the end of the row you can see when hovering over the row, to activate it in the login flow. ![Configure identity provider](/img/console_org_identity_provider.gif) -### 4.Send the primary domain scope on the authorization request +### 4. Send the primary domain scope on the authorization request ZITADEL will show a set of identity providers by default. This configuration can be changed by users with the [manager role] (https://docs.zitadel.com/docs/concepts/zitadel/objects/managers) `IAM_OWNER`. An organization's login settings will be shown @@ -99,20 +102,9 @@ An organization's login settings will be shown To get your own configuration you will have to send the [primary domain scope](https://docs.zitadel.com/docs/apis/openidoauth/scopes#reserved-scopes) in your [authorization request](https://docs.zitadel.com/docs/guides/authentication/login-users/#auth-request) . The primary domain scope will restrict the login to your organization, so only users of your own organization will be able to login, also your branding and policies will trigger. -See the following link as an example. Users will be able to register and login to the organization that verified the @caos.ch domain only. -``` -https://accounts.zitadel.ch/oauth/v2/authorize?client_id=69234247558357051%40zitadel&scope=openid%20profile%20urn%3Azitadel%3Aiam%3Aorg%3Adomain%3Aprimary%3Acaos.ch&redirect_uri=https%3A%2F%2Fconsole.zitadel.ch%2Fauth%2Fcallback&state=testd&response_type=code&nonce=test&code_challenge=UY30LKMy4bZFwF7Oyk6BpJemzVblLRf0qmFT8rskUW0 -``` +:::note -:::info - -Make sure to replace the domain `caos.ch` with your own domain to trigger the correct branding. - -::: - -:::caution - -This example uses the ZITADEL Cloud Application for demonstration. You need to create your own auth request with your applications parameters. Please see the docs to construct an [Auth Request](https://docs.zitadel.com/docs/guides/authentication/login-users/#auth-request). +You need to create your own auth request with your applications parameters. Please see the docs to construct an [Auth Request](https://docs.zitadel.com/docs/guides/authentication/login-users/#auth-request). ::: diff --git a/docs/docs/guides/basics/projects.md b/docs/docs/guides/basics/projects.md index 51875a77b..79e43860f 100644 --- a/docs/docs/guides/basics/projects.md +++ b/docs/docs/guides/basics/projects.md @@ -68,7 +68,7 @@ import GrantedProjectDescription from '../../concepts/structure/_granted_project 3. Select some roles you would like to grant to the organization ACME and confirm. 4. You should now see ACME-CAOS in the section GRANTED ORGANIZATIONS -![Grant a project](/img/projects_create_org_grant_caos2acme.gif) +![Grant a project](/img/projects_create_org_grant.gif) ## Knowledge Check (2) diff --git a/docs/docs/manuals/customerportal/notifications.md b/docs/docs/manuals/customerportal/notifications.md new file mode 100644 index 000000000..99263924a --- /dev/null +++ b/docs/docs/manuals/customerportal/notifications.md @@ -0,0 +1,21 @@ +--- +title: Notifications +--- + +You can subscribe to different newsletters and notifications. + +## Change Notification/Newsletter settings + +1. Click on your user avatar in the top right +2. In the menu that has opend you can see click on "Edit Notifications" +3. You can see all the different newsletters and notifications and can now enable or disable them + + +![Create user](/img/manuals/portal/customer_portal_notifications.png) + +## Notifications + +Onboarding: The onboarding list will provide you with some information when you first created your account +Newsletter: The newsletter will contain any news about the company, the product and what happens around. (e.g Blogs, Funding, etc) +Product News: You will get some news about the product, changes and new features +Security: Security should possibly not be disabled, we will send some security relevant information and critical issues here. \ No newline at end of file diff --git a/docs/docs/manuals/customerportal/start.md b/docs/docs/manuals/customerportal/start.md index af2a08a5e..660f2477a 100644 --- a/docs/docs/manuals/customerportal/start.md +++ b/docs/docs/manuals/customerportal/start.md @@ -14,7 +14,6 @@ To get started, enter the following data: - Email - Username - Organization Name -- Instance Name ![Customer Portal Landing Page](/img/manuals/portal/customer_portal_landing_page.png) diff --git a/docs/static/img/console_org_identitiy_provider.gif b/docs/static/img/console_org_identitiy_provider.gif new file mode 100644 index 000000000..54c30774b Binary files /dev/null and b/docs/static/img/console_org_identitiy_provider.gif differ diff --git a/docs/static/img/console_org_identity_provider.gif b/docs/static/img/console_org_identity_provider.gif index c8c408e45..ab16e915d 100644 Binary files a/docs/static/img/console_org_identity_provider.gif and b/docs/static/img/console_org_identity_provider.gif differ diff --git a/docs/static/img/google_add_credentials.gif b/docs/static/img/google_add_credentials.gif index 181963816..23aaf2052 100644 Binary files a/docs/static/img/google_add_credentials.gif and b/docs/static/img/google_add_credentials.gif differ diff --git a/docs/static/img/manuals/portal/customer_portal_landing_page.png b/docs/static/img/manuals/portal/customer_portal_landing_page.png index 2699a9b12..64455d582 100644 Binary files a/docs/static/img/manuals/portal/customer_portal_landing_page.png and b/docs/static/img/manuals/portal/customer_portal_landing_page.png differ diff --git a/docs/static/img/manuals/portal/customer_portal_notifications.png b/docs/static/img/manuals/portal/customer_portal_notifications.png new file mode 100644 index 000000000..80b18b0d3 Binary files /dev/null and b/docs/static/img/manuals/portal/customer_portal_notifications.png differ diff --git a/docs/static/img/projects_create_org_grant.gif b/docs/static/img/projects_create_org_grant.gif new file mode 100644 index 000000000..514f4b506 Binary files /dev/null and b/docs/static/img/projects_create_org_grant.gif differ diff --git a/docs/static/img/projects_create_org_grant_caos2acme.gif b/docs/static/img/projects_create_org_grant_caos2acme.gif deleted file mode 100644 index 5726ea794..000000000 Binary files a/docs/static/img/projects_create_org_grant_caos2acme.gif and /dev/null differ