docs:change titles (#6582)

* Modified quick start guide to reflect the new onboarding changes.

* Modified titles to optimize indexing. Left thet titles in title case for now.

* Added side bar labels and also made minor changes to titles.

* Update docs/docs/apis/openidoauth/endpoints.mdx

Co-authored-by: Fabi <fabienne@zitadel.com>

---------

Co-authored-by: Fabi <fabienne@zitadel.com>
This commit is contained in:
Dakshitha Ratnayake 2023-09-19 17:20:00 +05:30 committed by GitHub
parent a5decda201
commit 599a1ddd78
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
137 changed files with 304 additions and 201 deletions

View File

@ -1,5 +1,5 @@
--- ---
title: API Reference Overview title: ZITADEL API Reference Overview
sidebar_label: Overview sidebar_label: Overview
--- ---

View File

@ -1,5 +1,6 @@
--- ---
title: Ready / Healthy title: ZITADEL Ready and Health Enpoints
sidebar_label: Ready and Health Enpoints
--- ---
ZITADEL exposes a `Ready`- and `Healthy` endpoint to allow external systems like load balancers, orchestration systems, uptime probes and others to check the status. ZITADEL exposes a `Ready`- and `Healthy` endpoint to allow external systems like load balancers, orchestration systems, uptime probes and others to check the status.

View File

@ -1,5 +1,6 @@
--- ---
title: Metrics title: ZITADEL Metrics
sidebar_label: Metrics
--- ---
ZITADEL provides a `metrics` endpoint with the help of the [opentelemetry-go](https://github.com/open-telemetry/opentelemetry-go) package. ZITADEL provides a `metrics` endpoint with the help of the [opentelemetry-go](https://github.com/open-telemetry/opentelemetry-go) package.

View File

@ -1,5 +1,6 @@
--- ---
title: Authentication Methods title: Authentication Methods in ZITADEL
sidebar_label: Authentication Methods
--- ---
## Client Secret Basic ## Client Secret Basic

View File

@ -1,5 +1,5 @@
--- ---
title: OIDC Authentication Request Playground title: ZITADEL OIDC Authentication Request Playground
sidebar_label: OIDC Playground sidebar_label: OIDC Playground
--- ---

View File

@ -1,5 +1,6 @@
--- ---
title: Claims title: Claims in ZITADEL
sidebar_label: Claims
--- ---
ZITADEL asserts claims on different places according to the corresponding specifications or project and clients settings. ZITADEL asserts claims on different places according to the corresponding specifications or project and clients settings.

View File

@ -1,5 +1,6 @@
--- ---
title: OpenID Connect Endpoints title: OpenID Connect Endpoints in ZITADEL
sidebar_label: OpenID Connect Endpoints
--- ---
import Tabs from "@theme/Tabs"; import Tabs from "@theme/Tabs";

View File

@ -1,5 +1,6 @@
--- ---
title: Grant Types title: Grant Types in ZITADEL
sidebar_label: Grant Types
--- ---
For a list of supported or unsupported `Grant Types` please have a look at the table below. For a list of supported or unsupported `Grant Types` please have a look at the table below.

View File

@ -1,5 +1,6 @@
--- ---
title: Scopes title: Scopes in ZITADEL
sidebar_label: Scopes
--- ---
ZITADEL supports the usage of scopes as way of requesting information from the IAM and also instruct ZITADEL to do certain operations. ZITADEL supports the usage of scopes as way of requesting information from the IAM and also instruct ZITADEL to do certain operations.

View File

@ -1,5 +1,5 @@
--- ---
title: SAML endpoints title: SAML Endpoints in ZITADEL
--- ---
## SAML 2.0 metadata ## SAML 2.0 metadata

View File

@ -1,5 +1,6 @@
--- ---
title: GRPC Status Codes title: GRPC Status Codes in ZITADEL
sidebar_label: GRPC Status Codes
--- ---
| GRPC Number | GRPC Code | HTTP Status Code | HTTP Status Text |Description | | GRPC Number | GRPC Code | HTTP Status Code | HTTP Status Text |Description |

View File

@ -1,5 +1,6 @@
--- ---
title: Secrets title: How ZITADEL Processes and Stores Secrets
sidebar_label: Secrets
--- ---
In this chapter you can find information of how ZITADEL processes and stores secrets and credentials in a secure fashion. In this chapter you can find information of how ZITADEL processes and stores secrets and credentials in a secure fashion.

View File

@ -1,5 +1,6 @@
--- ---
title: Software title: ZITADEL's Software Architecture
sidebar_label: Software Architecture
--- ---
ZITADEL is built with two essential patterns. Event Sourcing (ES) and Command and Query Responsibility Segregation (CQRS). ZITADEL is built with two essential patterns. Event Sourcing (ES) and Command and Query Responsibility Segregation (CQRS).
@ -14,7 +15,7 @@ Each ZITADEL binary contains all components necessary to serve traffic
From serving the API, rendering GUI's, background processing of events and task. From serving the API, rendering GUI's, background processing of events and task.
This All in One (AiO) approach makes operating ZITADEL simple. This All in One (AiO) approach makes operating ZITADEL simple.
## Software Structure ## The Architecture
ZITADELs software architecture is built around multiple components at different levels. ZITADELs software architecture is built around multiple components at different levels.
This chapter should give you an idea of the components as well as the different layers. This chapter should give you an idea of the components as well as the different layers.

View File

@ -1,5 +1,6 @@
--- ---
title: Deployment title: ZITADEL's Deployment Architecture
sidebar_label: Deployment Architecture
--- ---
## High Availability ## High Availability

View File

@ -1,5 +1,6 @@
--- ---
title: Implementation title: ZITADEL Database Structure
sidebar_label: Database Structure
--- ---
This documentation gives you an insight into the structure of the ZITADEL database. This documentation gives you an insight into the structure of the ZITADEL database.

View File

@ -1,5 +1,5 @@
--- ---
title: Eventstore title: ZITADEL Event Store
sidebar_label: Overview sidebar_label: Overview
--- ---

View File

@ -1,5 +1,6 @@
--- ---
title: Actions title: ZITADEL Actions
sidebar_label: Actions
--- ---
By using ZITADEL actions, you can manipulate ZITADELs behavior on specific Events. By using ZITADEL actions, you can manipulate ZITADELs behavior on specific Events.

View File

@ -1,5 +1,6 @@
--- ---
title: Audit Trail title: ZITADEL's In-built Audit Trail
sidebar_label: Audit Trail
--- ---
ZITADEL provides you with an built-in audit trail to track all changes and events over an unlimited period of time. ZITADEL provides you with an built-in audit trail to track all changes and events over an unlimited period of time.

View File

@ -1,5 +1,6 @@
--- ---
title: Identity Brokering title: Identity Brokering in ZITADEL
sidebar_label: Identity Brokering
--- ---
## What are Identity Brokering and Federated Identities? ## What are Identity Brokering and Federated Identities?

View File

@ -1,5 +1,6 @@
--- ---
title: Self-Service title: Self Service in ZITADEL
sidebar_label: Self Service
--- ---
ZITADEL allows users to perform many tasks themselves. ZITADEL allows users to perform many tasks themselves.

View File

@ -1,5 +1,6 @@
--- ---
title: Applications title: ZITADEL Applications
sidebar_label: Applications
--- ---
# Applications # Applications

View File

@ -1,5 +1,6 @@
--- ---
title: Granted Projects title: ZITADEL's Granted Projects
sidebar_label: Granted Projects
--- ---
# Granted Project # Granted Project

View File

@ -1,5 +1,6 @@
--- ---
title: Instance title: ZITADEL Instances
sidebar_label: Instances
--- ---
## Instance Structure ## Instance Structure

View File

@ -1,5 +1,6 @@
--- ---
title: Managers title: ZITADEL Managers
sidebar_label: Managers
--- ---
import ManagerDescription from "./_manager_description.mdx"; import ManagerDescription from "./_manager_description.mdx";

View File

@ -1,5 +1,6 @@
--- ---
title: Organizations title: ZITADEL Organizations
sidebar_label: Organizations
--- ---
import OrgDescription from './_org_description.mdx'; import OrgDescription from './_org_description.mdx';

View File

@ -1,8 +1,9 @@
--- ---
title: Settings/Policies title: ZITADEL Settings and Policies
sidebar_label: Setting and Policies
--- ---
Settings and policies are configurations of all the different parts of the Instance or an organization. For all parts we have a suitable default in the Instance. Settings and policies are configurations of all the different parts of the instance or an organization. For all parts we have a suitable default in the instance.
The default configuration can be overridden for each organization, some policies are currently only available on the instance level. Learn more about our different policies [here](/guides/manage/console/instance-settings.mdx). The default configuration can be overridden for each organization, some policies are currently only available on the instance level. Learn more about our different policies [here](/guides/manage/console/instance-settings.mdx).
API wise, settings are often called policies. You can read the proto and swagger definitions [here](../../apis/introduction.mdx). API wise, settings are often called policies. You can read the proto and swagger definitions [here](../../apis/introduction.mdx).

View File

@ -1,5 +1,6 @@
--- ---
title: Projects title: ZITADEL Projects
sidebar_label: Projects
--- ---
# Project # Project

View File

@ -1,5 +1,6 @@
--- ---
title: Users title: ZITADEL Users
sidebar_label: Users
--- ---
## Types of users ## Types of users

View File

@ -1,5 +1,6 @@
--- ---
title: .NET title: Integrate ZITADEL into a .NET Application
sidebar_label: .NET
--- ---
This integration guide shows you how to integrate **ZITADEL** into your .NET application. This integration guide shows you how to integrate **ZITADEL** into your .NET application.

View File

@ -1,5 +1,6 @@
--- ---
title: Go title: Integrate ZITADEL into a Go Application
sidebar_label: Go
--- ---
This integration guide shows you how to integrate **ZITADEL** into your Go application. This integration guide shows you how to integrate **ZITADEL** into your Go application.

View File

@ -1,5 +1,5 @@
--- ---
title: Overview of examples, quickstarts, and SDKs title: Overview of ZITADEL Examples, Quickstarts, and SDKs
sidebar_label: Overview sidebar_label: Overview
--- ---

View File

@ -1,5 +1,6 @@
--- ---
title: Angular title: ZITADEL with Angular
sidebar_label: Angular
--- ---
This integration guide demonstrates the recommended way to incorporate ZITADEL into your Angular application. This integration guide demonstrates the recommended way to incorporate ZITADEL into your Angular application.

View File

@ -1,5 +1,7 @@
--- ---
title: Flutter title: ZITADEL with Flutter
sidebar_label: Flutter
--- ---
This guide demonstrates how you integrate **ZITADEL** into a Flutter app. It refers to our example on [GitHub](https://github.com/zitadel/zitadel_flutter) This guide demonstrates how you integrate **ZITADEL** into a Flutter app. It refers to our example on [GitHub](https://github.com/zitadel/zitadel_flutter)

View File

@ -1,8 +1,9 @@
--- ---
title: Next.js B2B Scenario title: ZITADEL with Next.js - A B2B Scenario
sidebar_label: Next.js - B2B
--- ---
This is our Zitadel [Next.js](https://nextjs.org/) B2B template. It shows how to authenticate as a user with multiple organizations. The application shows your users roles on the selected organizations, other projects your organization is allowed to use and other users having a grant to use the application. This is our ZITADEL [Next.js](https://nextjs.org/) B2B template. It shows how to authenticate as a user with multiple organizations. The application shows your users roles on the selected organizations, other projects your organization is allowed to use and other users having a grant to use the application.
If you need more info on B2B use cases consider reading our guide for the [B2B solution scenario](/guides/solution-scenarios/b2b.mdx). If you need more info on B2B use cases consider reading our guide for the [B2B solution scenario](/guides/solution-scenarios/b2b.mdx).

View File

@ -1,5 +1,6 @@
--- ---
title: Next.js title: ZITADEL with Next.js
sidebar_label: Next.js
--- ---
This is our Zitadel [Next.js](https://nextjs.org/) template. It shows how to authenticate as a user and retrieve user information from the OIDC endpoint. This is our Zitadel [Next.js](https://nextjs.org/) template. It shows how to authenticate as a user and retrieve user information from the OIDC endpoint.

View File

@ -1,5 +1,6 @@
--- ---
title: React title: ZITADEL with React
sidebar_label: React
--- ---
This Integration guide shows you the recommended way to integrate **ZITADEL** into your React Application. This Integration guide shows you the recommended way to integrate **ZITADEL** into your React Application.

View File

@ -1,5 +1,6 @@
--- ---
title: SDKs title: ZITADEL SDKs
sidebar_label: SDKs
--- ---
On this page you find our official SDKs, links to supporting frameworks and providers, and resources to help with SDKs. On this page you find our official SDKs, links to supporting frameworks and providers, and resources to help with SDKs.

View File

@ -1,4 +1,5 @@
--- ---
title: .NET title: ZITADEL with .NET
sidebar_label: .NET
--- ---
Coming soon Coming soon

View File

@ -1,5 +1,6 @@
--- ---
title: Go title: ZITADEL with Go
sidebar_label: Go
--- ---
This integration guide shows you how to integrate **ZITADEL** into your Go API. It demonstrates how to secure your API using This integration guide shows you how to integrate **ZITADEL** into your Go API. It demonstrates how to secure your API using

View File

@ -1,5 +1,6 @@
--- ---
title: Python title: ZITADEL with Python
sidebar_label: Python
--- ---
This example shows you how to secure a Python3 Flask API with both authentication and authorization using ZITADEL. This example shows you how to secure a Python3 Flask API with both authentication and authorization using ZITADEL.

View File

@ -1,5 +1,6 @@
--- ---
title: Authenticated MongoDB Charts title: Embed Authenticated MongoDB Charts Using ZITADEL
sidebar_label: Authenticated MongoDB Charts
--- ---
This integration guide shows how you can embed authenticated MongoDB Charts in your web application using ZITADEL as authentication provider. This integration guide shows how you can embed authenticated MongoDB Charts in your web application using ZITADEL as authentication provider.

View File

@ -1,5 +1,6 @@
--- ---
title: Get events from ZITADEL title: Get Events from ZITADEL
sidebar_label: Events
--- ---
ZITADEL leverages the power of eventsourcing, meaning every action and change within the system generates a corresponding event that is stored in the database. ZITADEL leverages the power of eventsourcing, meaning every action and change within the system generates a corresponding event that is stored in the database.

View File

@ -1,5 +1,5 @@
--- ---
title: Configure Apple as Identity Provider title: Configure Apple as an Identity Provider in ZITADEL
sidebar_label: Apple sidebar_label: Apple
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Configure Azure AD as Identity Provider title: Configure Azure AD as an Identity Provider in ZITADEL
sidebar_label: Azure AD sidebar_label: Azure AD
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Configure GitHub as Identity Provider title: Configure GitHub as an Identity Provider in ZITADEL
sidebar_label: GitHub sidebar_label: GitHub
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Configure GitLab as Identity Provider title: Configure GitLab as an Identity Provider in ZITADEL
sidebar_label: GitLab sidebar_label: GitLab
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Configure Google as Identity Provider title: Configure Google as an Identity Provider in ZITADEL
sidebar_label: Google sidebar_label: Google
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Configure LDAP as Identity Provider title: Configure LDAP as an Identity Provider in ZITADEL
sidebar_label: LDAP sidebar_label: LDAP
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Configure OKTA as Identity Provider title: Configure OKTA as an Identity Provider in ZITADEL
sidebar_label: OKTA generic OIDC sidebar_label: OKTA generic OIDC
id: okta id: okta
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Configure local OpenLDAP as Identity Provider title: Configure Local OpenLDAP as an Identity Provider in ZITADEL
sidebar_label: Local OpenLDAP sidebar_label: Local OpenLDAP
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Handle External Login title: Handle External Logins in ZITADEL
sidebar_label: External Identity Provider sidebar_label: External Identity Provider
--- ---

View File

@ -1,5 +1,6 @@
--- ---
title: Logout title: Logging Out via ZITADEL
sidebar_label: Logout
--- ---
import Logout from './_logout.mdx'; import Logout from './_logout.mdx';

View File

@ -1,6 +1,6 @@
--- ---
title: Multi-Factor (MFA) title: Multi-Factor Authentication(MFA) in ZITADEL
sidebar_label: Multi-Factor (MFA) sidebar_label: Multi-Factor Authentication(MFA)
--- ---
import MfaOptions from './_list-mfa-options.mdx'; import MfaOptions from './_list-mfa-options.mdx';

View File

@ -1,5 +1,6 @@
--- ---
title: OIDC Standard title: Support for the OpenID Connect(OIDC) Standard in ZITADEL
sidebar_label: OIDC Standard
--- ---
To build your own login ui for your own application it is not necessary to have the OIDC standard included or any additional work that has to be done. To build your own login ui for your own application it is not necessary to have the OIDC standard included or any additional work that has to be done.

View File

@ -1,5 +1,5 @@
--- ---
title: Passkeys title: Passkeys in ZITADEL
sidebar_label: Passkeys sidebar_label: Passkeys
--- ---

View File

@ -1,5 +1,6 @@
--- ---
title: Password Reset/Change title: Password Reset/Change in ZITADEL
sidebar_label: Password Reset/Change
--- ---
When your user is on the password screen and has forgotten his password you will probably want him to be able to reset by himself. When your user is on the password screen and has forgotten his password you will probably want him to be able to reset by himself.

View File

@ -1,5 +1,5 @@
--- ---
title: Register and Login User with Password title: Register and Login User with Password in ZITADEL
sidebar_label: Username and Password sidebar_label: Username and Password
--- ---

View File

@ -1,5 +1,6 @@
--- ---
title: Login Users into your Application title: Login Users into your Application with ZITADEL
sidebar_label: Login
--- ---
import Tabs from "@theme/Tabs"; import Tabs from "@theme/Tabs";

View File

@ -1,5 +1,6 @@
--- ---
title: Logout title: Log Out Users from an Application with ZITADEL
sidebar_label: Logout
--- ---
This guide shows you the different concepts and use cases of the logout process and how to use it in ZITADEL. This guide shows you the different concepts and use cases of the logout process and how to use it in ZITADEL.

View File

@ -1,5 +1,5 @@
--- ---
title: Recommended authorization flows title: Recommended Authorization Flows
--- ---
<table className="table-wrapper"> <table className="table-wrapper">

View File

@ -1,5 +1,6 @@
--- ---
title: PAT (Personal Access Token) title: ZITADEL's Personal Access Tokens(PATs)
sidebar_label: Personal Access Tokens(PATs)
--- ---

View File

@ -1,5 +1,6 @@
--- ---
title: Private Key JWT title: Service Users in ZITADEL
sidebar_label: Service Users
--- ---
This is a guide on how to create service users in ZITADEL. You can read more about users [here](/concepts/structure/users.md). This is a guide on how to create service users in ZITADEL. You can read more about users [here](/concepts/structure/users.md).

View File

@ -1,5 +1,6 @@
--- ---
title: Retrieve user roles title: Retrieve User Roles in ZITADEL
sidebar_label: Retrieve User Roles
--- ---
This guide explains all the possible ways of retrieving user roles across different organizations and projects using ZITADEL's APIs. This guide explains all the possible ways of retrieving user roles across different organizations and projects using ZITADEL's APIs.

View File

@ -1,5 +1,5 @@
--- ---
title: Connect with Atlassian through SAML 2.0 title: Log in with ZITADEL on Atlassian through SAML 2.0
sidebar_label: Atlassian sidebar_label: Atlassian
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Connect with Auth0 through OIDC title: Log in with ZITADEL on Auth0 through OIDC
sidebar_label: Auth0 (OIDC) sidebar_label: Auth0 (OIDC)
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Connect with Auth0 through SAML 2.0 title: Log in with ZITADEL on Auth0 through SAML 2.0
sidebar_label: Auth0 (SAML) sidebar_label: Auth0 (SAML)
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Connect with AWS through SAML 2.0 title: Log in with ZITADEL on AWS through SAML 2.0
sidebar_label: Amazon Web Services sidebar_label: Amazon Web Services
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Configure as OIDC Identity Provider for Cloudflare Zero Trust title: Configure ZITADEL as an OIDC Identity Provider on Cloudflare Zero Trust
sidebar_label: Cloudflare Zero Trust sidebar_label: Cloudflare Zero Trust
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Connect with Gitlab through SAML 2.0 title: Log in with ZITADEL on Gitlab through SAML 2.0
sidebar_label: Gitlab sidebar_label: Gitlab
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Gitlab OmniAuth Provider title: Log in with ZITADEL on Gitlab OmniAuth Provider
--- ---
import CreateApp from "../application/_application.mdx"; import CreateApp from "../application/_application.mdx";

View File

@ -1,5 +1,5 @@
--- ---
title: Google Cloud with Workforce Identity Federation (OIDC) title: Log in with ZITADEL on Google Cloud with Workforce Identity Federation (OIDC)
sidebar_label: Google Cloud sidebar_label: Google Cloud
--- ---

View File

@ -1,9 +1,9 @@
--- ---
title: Connect with Ping Identity through SAML 2.0 title: Log in with ZITADEL on Ping Identity through SAML 2.0
sidebar_label: Ping Identity sidebar_label: Ping Identity
--- ---
This guide shows how to enable login with ZITADEL on Auth0. This guide shows how to enable login with ZITADEL on Ping Identity.
It covers how to: It covers how to:

View File

@ -1,5 +1,6 @@
--- ---
title: Basic authentication title: Basic Authentication in ZITADEL
sidebar_label: Basic Authentication
--- ---
import IntrospectionResponse from './_introspection-response.mdx'; import IntrospectionResponse from './_introspection-response.mdx';

View File

@ -1,5 +1,6 @@
--- ---
title: JSON Web Token profile title: JSON Web Token Profile in ZITADEL
sidebar_label: JSON Web Token(JWT) Profile
--- ---
import IntrospectionResponse from './_introspection-response.mdx'; import IntrospectionResponse from './_introspection-response.mdx';

View File

@ -1,8 +1,9 @@
--- ---
title: Instances title: ZITADEL Instances
sidebar_label: Instances
--- ---
The ZITADEL customer Portal is used to manage all your different ZITADEL instances. The ZITADEL Customer Portal is used to manage all your different ZITADEL instances.
You can also manage your subscriptions, billing, newsletters and support requests. You can also manage your subscriptions, billing, newsletters and support requests.
## Overview ## Overview

View File

@ -1,5 +1,6 @@
--- ---
title: Notifications title: ZITADEL Notifications
sidebar_label: Notifications
--- ---
You can subscribe to different newsletters and notifications. You can subscribe to different newsletters and notifications.

View File

@ -1,5 +1,6 @@
--- ---
title: Getting Started title: Getting Started with ZITADEL
sidebar_label: Getting Started
--- ---
If you are new to ZITADEL your first action is to create your first ZITADEL instance and an account to access the ZITADEL Customer Portal. If you are new to ZITADEL your first action is to create your first ZITADEL instance and an account to access the ZITADEL Customer Portal.

View File

@ -1,5 +1,6 @@
--- ---
title: Support title: ZITADEL Support
sidebar_label: Support
--- ---
:::note :::note

View File

@ -1,5 +1,6 @@
--- ---
title: Users title: Customer Portal Users in ZITADEL
sidebar_label: Customer Portal Users
--- ---
Manage all your users who are allowed to access the Customer Portal. Manage all your users who are allowed to access the Customer Portal.

View File

@ -1,5 +1,6 @@
--- ---
title: Actions title: ZITADEL Actions
sidebar_label: Actions
--- ---
An Identity and Management system is a very interactive place. ZITADEL has built in functionality to react to its events. This functionality is called **Actions** and can be accessed from your organizations top navigation. An Identity and Management system is a very interactive place. ZITADEL has built in functionality to react to its events. This functionality is called **Actions** and can be accessed from your organizations top navigation.

View File

@ -1,5 +1,6 @@
--- ---
title: Applications title: ZITADEL Applications
sidebar_label: Applications
--- ---
import ThemedImage from "@theme/ThemedImage"; import ThemedImage from "@theme/ThemedImage";
@ -7,7 +8,7 @@ import ThemedImage from "@theme/ThemedImage";
import AuthType from "../../integrate/application/_auth-type.mdx"; import AuthType from "../../integrate/application/_auth-type.mdx";
import ReviewConfig from "../../integrate/application/_review-config.mdx"; import ReviewConfig from "../../integrate/application/_review-config.mdx";
# What is an application? ## What is an application?
Applications are the entry point to your project. Applications are the entry point to your project.
Users either login into one of your clients and interact with them directly or use one of your APIs. Users either login into one of your clients and interact with them directly or use one of your APIs.

View File

@ -1,5 +1,6 @@
--- ---
title: Instance Settings title: ZITADEL Instance Settings
sidebar_label: Instance Settings
--- ---
Instance settings work as default or fallback settings for your organizational settings. Most of the time you only have to set instance settings for the cases where you don't need specific behaviour in the organizations themselves or you only have one organization. Instance settings work as default or fallback settings for your organizational settings. Most of the time you only have to set instance settings for the cases where you don't need specific behaviour in the organizations themselves or you only have one organization.

View File

@ -1,5 +1,6 @@
--- ---
title: Managers title: ZITADEL Managers
sidebar_label: Managers
--- ---
import ManagerDescription from "../../../concepts/structure/_manager_description.mdx"; import ManagerDescription from "../../../concepts/structure/_manager_description.mdx";

View File

@ -1,5 +1,6 @@
--- ---
title: Organizations title: ZITADEL Organizations
sidebar_label: Organizations
--- ---
## What is an organization? ## What is an organization?

View File

@ -1,5 +1,5 @@
--- ---
title: Console title: ZITADEL Console
sidebar_label: Overview sidebar_label: Overview
--- ---

View File

@ -1,5 +1,6 @@
--- ---
title: Projects title: ZITADEL Projects
sidebar_label: Projects
--- ---
## What is a project? ## What is a project?

View File

@ -1,5 +1,6 @@
--- ---
title: Roles and Authorizations title: ZITADEL Roles and Authorizations
sidebar_label: Roles and Authorizations
--- ---
If you would build out the [POS use case example](./projects#example) you would probably need an application for administration. If you would build out the [POS use case example](./projects#example) you would probably need an application for administration.

View File

@ -1,5 +1,6 @@
--- ---
title: Users title: ZITADEL Users
sidebar_label: Users
--- ---
ZITADEL differs two different types of users: ZITADEL differs two different types of users:

View File

@ -1,16 +1,17 @@
--- ---
title: Terraform Provider Basics title: ZITADEL Terraform Provider
sidebar_label: Terraform Provider
--- ---
It covers how to: It covers how to:
- manage ZITADEL resources through the ZITADEL Terraform provider - Manage ZITADEL resources through the ZITADEL Terraform provider
Prerequisites: Prerequisites:
- existing ZITADEL Instance, if not present follow [this guide](../../start/quickstart) - A ZITADEL Instance, if not present follow [this guide](../../start/quickstart)
- existing user with enough authorization to manage the desired resources, if not present follow [this guide](../../integrate/serviceusers) - A user with enough authorization to manage the desired resources, if not present follow [this guide](../../integrate/serviceusers)
- installed Terraform, if not present follow [this guide](https://learn.hashicorp.com/tutorials/terraform/install-cli) - Installed Terraform, if not present follow [this guide](https://learn.hashicorp.com/tutorials/terraform/install-cli)
## Manage ZITADEL resources through terraform ## Manage ZITADEL resources through terraform

View File

@ -1,5 +1,5 @@
--- ---
title: Migrate from Auth0 title: Migrate from Auth0 to ZITADEL
sidebar_label: From Auth0 sidebar_label: From Auth0
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Documentation title: ZITADEL Documentation
sidebar_label: Overview sidebar_label: Overview
--- ---

View File

@ -1,5 +1,6 @@
--- ---
title: B2B title: ZITADEL for B2B Scenarios
sidebar_label: B2B
--- ---
import { B2B } from "../../../src/components/b2b"; import { B2B } from "../../../src/components/b2b";

View File

@ -1,5 +1,6 @@
--- ---
title: B2C title: ZITADEL for B2C Scenarios
sidebar_label: B2C
--- ---
import Column from "../../../src/components/column"; import Column from "../../../src/components/column";

View File

@ -1,6 +1,6 @@
--- ---
title: How to configure ZITADEL for your scenario title: Configure ZITADEL for your Scenario
sidebar_label: Common configurations sidebar_label: Common Configurations
--- ---
Each customer does have different needs and use-cases. In ZITADEL you are able to configure your settings depending on your needs. Each customer does have different needs and use-cases. In ZITADEL you are able to configure your settings depending on your needs.

View File

@ -1,5 +1,6 @@
--- ---
title: Domain Discovery title: Domain Discovery in ZITADEL
sidebar_label: Domain Discovery
--- ---
This guide should explain how domain discovery works and how to configure it in ZITADEL. This guide should explain how domain discovery works and how to configure it in ZITADEL.

View File

@ -1,5 +1,6 @@
--- ---
title: Frontend and API communication title: Frontend and Back-end API Communication in ZITADEL
sidebar_label: Frontent and API Communcation
--- ---
This guide contains a use case and ZITADEL integration. This guide contains a use case and ZITADEL integration.

View File

@ -1,5 +1,5 @@
--- ---
title: SaaS Product with Authentication and Authorization title: Set up a SaaS Product with Authentication and Authorization using ZITADEL
sidebar_label: Software-as-a-Service sidebar_label: Software-as-a-Service
--- ---

View File

@ -1,5 +1,6 @@
--- ---
title: Quick start guide title: The ZITADEL Quick Start Guide
sidebar_label: Quick Start Guide
--- ---
import VSCodeFolderView from "../../../static/img/guides/quickstart/vscode1.png"; import VSCodeFolderView from "../../../static/img/guides/quickstart/vscode1.png";
@ -66,45 +67,55 @@ The order of creation for the above components may vary depending on the specifi
### 1. Sign up for the ZITADEL Cloud customer portal and register your organization ### 1. Sign up for the ZITADEL Cloud customer portal and register your organization
1. Go to [zitadel.com](http://zitadel.com) and click on “Start for FREE”. 1. Go to [zitadel.com](http://zitadel.com) and click “Start for FREE”.
![Home Page](/img/guides/quickstart/1.png) ![Home Page](/img/guides/quickstart/v3_1.png)
2. Enter your details as shown below and click the "Let's go" button.
![Registration Page](/img/guides/quickstart/2.png) 2. You can sign up by entering your email address or via social login, e.g., Google. Let's sign up using an email address. Enter your email address and click "Sign in with Email".
3. You will receive a verification email to verify the user for the Customer Portal. Click the “Sign in” button. ![Registration Page](/img/guides/quickstart/v3_2.png)
![Congratulations Page](/img/guides/quickstart/3.png)
4. You will be prompted for a code, which has been emailed to you. 3. Next, complete your details and click "Continue".
![Code](/img/guides/quickstart/4.png) ![Congratulations Page](/img/guides/quickstart/v3_3.png)
5. Check your inbox for the code. You can either click the “Finish initialization” button in the email itself or copy the code and return to the previous page. In this guide, we will copy the code and then continue from where we left off.
![Inbox](/img/guides/quickstart/5.png) 4. Add a password as shown below. Adhere to the password requirements, agree to the terms of service and privacy policy by selecting the checkbox, and click the "Get started" button.
6. Paste the code and add a password as shown below. Click on the “next” button. ![Code](/img/guides/quickstart/v3_4.png)
![Code](/img/guides/quickstart/6.png)
7. The user is now activated. Click on “next” to log in. 5. Enter your login data. Provide the password you just created. Click "next".
![User Activated](/img/guides/quickstart/7.png) ![Inbox](/img/guides/quickstart/v3_5.png)
8. Login with the username and password that you provided. Click “next”.
![Login](/img/guides/quickstart/8.png) 6. You will now have to verify your email address.
9. You should set up 2-factor authentication. However, we will skip this step for now. Click on “skip”. ![Verify Email](/img/guides/quickstart/v3_17.png)
![2-factor Authentication](/img/guides/quickstart/9.png)
10. You will now be asked to create an instance. 6. Go to your inbox and open the email from ZITADEL and click the "Verify email" button.
![Code](/img/guides/quickstart/v3_6.png)
7. The user is now activated. Click the "login" button.
![User Activated](/img/guides/quickstart/v3_7.png)
8. Now you will have to log in with the username and password that you provided. Click “Sign in with Email”.
![Login](/img/guides/quickstart/v3_8.png)
9. You will now be asked to create an instance.
![2-factor Authentication](/img/guides/quickstart/v3_9.png)
![Create Instance](/img/guides/quickstart/10.png)
### 2. Create your first instance ### 2. Create your first instance
@ -112,41 +123,51 @@ As a user of the ZITADEL Cloud Customer Portal, you now can create multiple inst
1. Lets create an instance. Click on “Create new instance”. 1. Lets create an instance. Click on “Create new instance”.
![Create Instance](/img/guides/quickstart/10.png) ![2-factor Authentication](/img/guides/quickstart/v3_9.png)
2. Provide a name for your instance, select the “Free” plan and click on the “Continue” button at the bottom of this screen. 2. Provide a name for your instance, select the “Free” plan and click on the “Continue” button at the bottom of this screen.
![Select Tier](/img/guides/quickstart/v2_1.png) ![Select Tier](/img/guides/quickstart/v3_10.png)
3. Next, you should see the following screen. Add a username and password for the instance manager and click "Create". 3. Next, you should see the following screen. Add a username and password for the instance manager and click "Create".
![Instance Details](/img/guides/quickstart/v2_2.png)
![Instance Details](/img/guides/quickstart/v3_11.png)
4. The instance creation process will take a few seconds. 4. The instance creation process will take a few seconds.
![Instance Details](/img/guides/quickstart/v2_3.png) ![Instance Details](/img/guides/quickstart/v3_12.png)
5. Now you will see the details of your first instance. You can click on "Visit" at the top right to go to your instance. 5. Now you will see the details of your first instance. You can click on "Visit" at the top right to go to your instance.
![Instance Details](/img/guides/quickstart/v2_4.png) ![Instance Details](/img/guides/quickstart/v3_13.png)
6. To log in to your instance, provide the username and password, and click “next”. 6. To log in to your instance, provide the username and password, and click “next”.
![Instance Details](/img/guides/quickstart/v2_5.png) ![Instance Details](/img/guides/quickstart/v3_14.png)
7. Skip the 2-factor authentication for now by clicking “skip”. 7. Skip the 2-factor authentication for now by clicking “skip”.
![Instance Details](/img/guides/quickstart/v2_6.png) ![Instance Details](/img/guides/quickstart/v3_15.png)
10. And there you go! You now have access to your instance. 8. And there you go! You now have access to your instance.
![Instance Details](/img/guides/quickstart/v3_16.png)
![Access Instance](/img/guides/quickstart/v2_7.png)
### 3. Create your first project ### 3. Create your first project
1. To create a project in the instance you just created, click on “Create Project”. 1. To create a project in the instance you just created, click on “Create a project”.
![Create Project](/img/guides/quickstart/v3_16.png)
![Create Project](/img/guides/quickstart/19.png)
2. Insert “Project1” (or any name of your choice) as the projects name and click the “Continue” button. 2. Insert “Project1” (or any name of your choice) as the projects name and click the “Continue” button.

View File

@ -1,5 +1,6 @@
--- ---
title: Account Lockout Policy title: ZITADEL Account Lockout Policy
sidebar_label: Account Lockout Policy
custom_edit_url: null custom_edit_url: null
--- ---

View File

@ -1,5 +1,6 @@
--- ---
title: Docker Compose title: Set up ZITADEL with Docker Compose
sidebar_label: Docker Compose
--- ---
import CodeBlock from '@theme/CodeBlock'; import CodeBlock from '@theme/CodeBlock';

Some files were not shown because too many files have changed in this diff Show More