mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-13 01:25:11 +00:00
docs: add description frontmatter to content pages for SEO (#11654)
This commit is contained in:
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Migrate from Actions V1 to V2
|
||||
description: "Migrate from Actions V1 to V2 by transitioning custom logic to external HTTP endpoints using webhooks for better scalability and flexibility"
|
||||
sidebar_label: Migrate from V1 to V2
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Test Actions Event
|
||||
description: "Configure HTTP target endpoints to test and integrate custom workflows triggered by ZITADEL events."
|
||||
---
|
||||
|
||||
This guide shows you how to leverage the ZITADEL actions feature to react to events in your ZITADEL instance.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Test Actions Function Manipulation
|
||||
description: "Create targets for specific ZITADEL functions and execute external code during OIDC flows using HTTP requests and custom claims"
|
||||
---
|
||||
|
||||
This guide shows you how to leverage the ZITADEL actions feature to enhance different functions in your ZITADEL instance.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Test Actions Function
|
||||
description: "Create an HTTP server as a target for ZITADEL actions to execute custom logic during OIDC or SAML flows"
|
||||
---
|
||||
|
||||
This guide shows you how to leverage the ZITADEL actions feature to enhance different functions in your ZITADEL instance.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Test Actions Request Manipulation
|
||||
description: "Create an HTTP server as a target to receive and manipulate API requests using ZITADEL's actions feature for custom integration"
|
||||
---
|
||||
|
||||
This guide shows you how to leverage the ZITADEL actions feature to manipulate API requests in your ZITADEL instance.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Verify Payload Integrity
|
||||
description: "Validate payload integrity by verifying JSON, JWT, or JWE signatures when receiving data from ZITADEL actions"
|
||||
---
|
||||
|
||||
import JsonGo from './go/json.go';
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Test Actions Request
|
||||
description: "Create an HTTP server as a target to receive and process Actions Request from ZITADEL instances during API calls"
|
||||
---
|
||||
|
||||
This guide shows you how to leverage the ZITADEL actions feature to react to API requests in your ZITADEL instance.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Test Actions Response Manipulation
|
||||
description: "Manipulate API responses in your ZITADEL instance by creating targets that handle specific response events with custom logic"
|
||||
---
|
||||
|
||||
This guide shows you how to leverage the ZITADEL actions feature to manipulate API responses in your ZITADEL instance.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Test Actions Response
|
||||
description: "Create an HTTP server as a target to receive and process API response events from ZITADEL instances using Actions"
|
||||
---
|
||||
|
||||
This guide shows you how to leverage the ZITADEL actions feature to react to API responses in your ZITADEL instance.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Using Actions
|
||||
description: "Define targets and executions to create custom workflows triggered by API requests, events, or internal scripts with ZITADEL Actions."
|
||||
---
|
||||
|
||||
The Action API provides a flexible mechanism for customizing and extending the functionality of ZITADEL. By allowing you to define targets and executions, you can implement custom workflows triggered on an API requests and responses, events or specific functions.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Testing Actions V2 with Webhook.site
|
||||
description: "Forward ZITADEL Actions V2 events to Webhook.site and verify them locally using XHR Redirect and CORS headers setup"
|
||||
sidebar_label: Testing Actions V2 with Webhook.site
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Embed Authenticated MongoDB Charts Using ZITADEL
|
||||
description: "Configure ZITADEL as custom JWT provider for authenticated MongoDB Charts using RS256 and JWKs URL"
|
||||
sidebar_label: Authenticated MongoDB Charts
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: OIDC Back-Channel Logout
|
||||
description: "Notify applications about session termination at OpenID Providers using ZITADEL's Back-Channel Logout implementation and logout tokens"
|
||||
sidebar_label: Back-Channel Logout
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Streaming audit logs to external systems (SIEM/SOC)
|
||||
description: "Stream ZITADEL audit logs to external systems like SIEM solutions using Events API or Webhooks for centralized monitoring and compliance reporting"
|
||||
sidebar_label: Audit Logs (SIEM / SOC)
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Profile Pre-filling from External IdP
|
||||
description: "Pre-fill user profiles using attributes from external identity providers to automate onboarding."
|
||||
sidebar_label: Profile Pre-filling from External IdP
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Set up Apple as an Identity Provider in ZITADEL
|
||||
description: "Configure Apple as an OIDC identity provider in ZITADEL to allow your users to sign in with their Apple IDs."
|
||||
sidebar_label: Apple
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Set up Entra ID as an Identity Provider in ZITADEL
|
||||
description: "Configure Microsoft Entra ID (formerly Azure AD) as an OIDC identity provider for enterprise Single Sign-On."
|
||||
sidebar_label: Entra ID
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Set up Entra ID as a SAML Service Provider in ZITADEL
|
||||
description: "Configure Entra ID as a SAML Service Provider in ZITADEL for secure authentication with custom attribute mapping"
|
||||
sidebar_label: Entra ID SAML
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Configure a Generic OIDC Identity Provider in ZITADEL
|
||||
description: "Configure a generic OpenID Connect (OIDC) Identity Provider in ZITADEL to enable user authentication with external credentials."
|
||||
sidebar_label: Generic OIDC
|
||||
id: generic-oidc
|
||||
---
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Configure GitHub as an Identity Provider in ZITADEL
|
||||
description: "Enable GitHub social login by configuring GitHub as an external identity provider in ZITADEL."
|
||||
sidebar_label: GitHub
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Configure GitLab as an Identity Provider in ZITADEL
|
||||
description: "Connect GitLab as an external Identity Provider in ZITADEL for secure authentication using client ID and secret"
|
||||
sidebar_label: GitLab
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Configure Google as an Identity Provider in ZITADEL
|
||||
description: "Configuring Google as an external identity provider for social login in ZITADEL."
|
||||
sidebar_label: Google
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Let Users Login with Preferred Identity Provider
|
||||
description: "Configure external Identity Providers (IdPs) like Google, GitHub, and Microsoft Entra ID with ZITADEL for Single Sign-On."
|
||||
sidebar_label: Login users with SSO
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: JWT IdP
|
||||
description: "Validate JSON Web Tokens from external systems as proof of user authentication in ZITADEL for single sign-on."
|
||||
sidebar_label: JWT IdP
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Configure Keycloak as an Identity Provider in ZITADEL
|
||||
description: "Configure Keycloak as an OIDC Identity Provider in ZITADEL to enable secure authentication and authorization flows"
|
||||
sidebar_label: Keycloak generic OIDC
|
||||
id: keycloak
|
||||
---
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Configure LDAP as an Identity Provider in ZITADEL
|
||||
description: "Connect ZITADEL to an LDAP server to use existing directory users for authentication and authorization."
|
||||
sidebar_label: LDAP
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Set up LinkedIn as an OAuth Identity Provider in ZITADEL
|
||||
description: "Configure LinkedIn as an OAuth Identity Provider in ZITADEL to enable secure login with LinkedIn credentials"
|
||||
sidebar_label: LinkedIn generic OAuth
|
||||
id: linkedin-oauth
|
||||
---
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Migrate from Generic Provider to specific Identity Provider
|
||||
description: "Migrate from generic OIDC provider to Entra ID or Google using API requests or Terraform for user connectivity"
|
||||
sidebar_label: Migrate IdP
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Set up MockSAML as an Identity Provider in ZITADEL
|
||||
description: "Set up MockSAML as an Identity Provider in ZITADEL to test user authentication and autofill user data using Actions"
|
||||
sidebar_label: MockSAML
|
||||
id: mocksaml
|
||||
---
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Set up OKTA as an OIDC Identity Provider in ZITADEL
|
||||
description: "Configure OKTA as an OIDC Identity Provider in ZITADEL by registering a new client and adding it to your login policy"
|
||||
sidebar_label: OKTA generic OIDC
|
||||
id: okta-oidc
|
||||
---
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Set up OKTA as a SAML Identity Provider in ZITADEL
|
||||
description: "Configure OKTA as a SAML Identity Provider in ZITADEL to enable single sign-on with custom attribute mappings"
|
||||
sidebar_label: OKTA SAML
|
||||
id: okta-saml
|
||||
---
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Set up OneLogin as a SAML Identity Provider in ZITADEL
|
||||
description: "Configure OneLogin as a SAML Identity Provider in ZITADEL to enable secure authentication and single sign-on"
|
||||
sidebar_label: OneLogin SAML
|
||||
id: onelogin-saml
|
||||
---
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Set up Local OpenLDAP as an Identity Provider in ZITADEL
|
||||
description: "Configure a local OpenLDAP server as an Identity Provider in ZITADEL to authenticate users with custom credentials"
|
||||
sidebar_label: Local OpenLDAP
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Set up PingFederate as a SAML Identity Provider in ZITADEL
|
||||
description: "Configure PingFederate as a SAML Identity Provider in ZITADEL to enable secure authentication and single sign-on"
|
||||
sidebar_label: PingFederate SAML
|
||||
id: pingfederate-saml
|
||||
---
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Support for the Device Authorization Grant in a Custom Login UI
|
||||
description: "Implement the OAuth 2.0 Device Authorization Grant in your custom login UI for browserless devices."
|
||||
sidebar_label: Device Authorization
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Handle External Logins in a Custom Login UI
|
||||
description: "Manage external identity provider logins (Google, GitHub, etc.) within a custom Login UI."
|
||||
sidebar_label: External Identity Provider
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Build your own Login UI"
|
||||
description: "In the following guides you will learn how to create your own login UI with our APIs. The different scenarios like username/password, external identity provider, etc. will be shown."
|
||||
description: "Create a completely customized login experience using the ZITADEL Session and OIDC APIs. Learn how to handle username/password, MFA, passkeys, and external identity providers."
|
||||
---
|
||||
|
||||
{/* THIS FILE IS AUTO-GENERATED FROM SIDEBAR-DATA.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Login App
|
||||
description: "Building a custom login application with ZITADEL: an overview of the OIDC and Session API integration."
|
||||
sidebar_label: Login App
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Logging Out via a Custom Login UI
|
||||
description: "Secure logout and session termination in a custom login user interface."
|
||||
sidebar_label: Logout
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Multi-Factor Authentication (MFA) in a Custom Login UI
|
||||
description: "Support multi-factor authentication (MFA) methods like TOTP, SMS, and WebAuthn in your custom login UI."
|
||||
sidebar_label: Multi-Factor Authentication (MFA)
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Support for the OpenID Connect(OIDC) Standard in a Custom Login UI
|
||||
description: "Support for the full OpenID Connect (OIDC) standard when building a custom login UI with ZITADEL."
|
||||
sidebar_label: OIDC Standard
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Using Passkeys in a Custom Login UI
|
||||
description: "Register and verify a Passkey with ZITADEL to enable phishing-resistant authentication using the FIDO Standard protocol"
|
||||
sidebar_label: Passkeys
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Password Reset/Change in a Custom Login UI
|
||||
description: "Request a password reset and send a verification code via ZITADEL or custom channel to users who forgot their passwords"
|
||||
sidebar_label: Password Reset/Change
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Support for the SAML Standard in a Custom Login UI
|
||||
description: "Proxy SAML requests from a custom login UI to the ZITADEL API for authentication with external applications"
|
||||
sidebar_label: SAML Standard
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Select Account in a Custom Login UI
|
||||
description: "Implement custom account selection logic using React components to handle user authentication flows with multiple identity providers"
|
||||
---
|
||||
|
||||
import SelectAccount from './_select-account.mdx';
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: How to Handle Session Validation
|
||||
description: "Validate user sessions in a custom Login UI by verifying authentication factors and expiration."
|
||||
sidebar_label: Session Validation
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Register and Login User with Password in a Custom Login UI
|
||||
description: "Create a new user with profile data and verify their email address using ZITADEL's registration flow"
|
||||
sidebar_label: Username and Password
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Login users into your application with a hosted login UI
|
||||
description: "Securely authenticate users via ZITADEL's hosted Single Sign-On (SSO) login page, supporting OIDC and SAML protocols."
|
||||
sidebar_label: Hosted Login UI
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Log users into your application with different authentication options
|
||||
description: "Overview of authentication protocols supported by ZITADEL, including OpenID Connect and SAML, for unified user login."
|
||||
sidebar_label: Authentication Options
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Authentication Methods
|
||||
description: "Overview of authentication methods for OIDC clients in ZITADEL, including JWT with Private Key and Client Secret."
|
||||
---
|
||||
|
||||
import AuthMethods from './_authmethods.mdx';
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Integrating Your Application with ZITADEL using RFC 8628 OAuth 2.0 Device Authorization Flow
|
||||
description: "Authenticate with ZITADEL using RFC 8628 Device Authorization Flow by obtaining user consent without browser interaction"
|
||||
sidebar_label: Device Authorization Flow
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Authenticate users with OpenID Connect (OIDC)"
|
||||
description: "This guide explains how to utilize ZITADEL for user authentication within your applications using OpenID Connect (OIDC). Here, we offer comprehensive guidance on seamlessly integrating ZITADEL's authentication features, ensuring both security and user experience excellence. Throughout this documentation, we'll cover the setup process for ZITADEL authentication, including the recommended OIDC flows tailored to different application types. Additionally, we'll provide clear instructions on securely signing out or logging out users from your application, ensuring data security and user privacy. With our guidance, you'll be equipped to leverage ZITADEL's authentication capabilities effectively, enhancing your application's security posture while delivering a seamless login experience for your users."
|
||||
description: "Comprehensive guide to user authentication in ZITADEL using OpenID Connect (OIDC), including recommended flows and session management."
|
||||
---
|
||||
|
||||
{/* THIS FILE IS AUTO-GENERATED FROM SIDEBAR-DATA.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Authenticate users with OpenID Connect
|
||||
description: "Authenticate users with OpenID Connect using ZITADEL's authorization code flow and Proof Key for Code Exchange (PKCE)"
|
||||
sidebar_label: OIDC Code Flow + PKCE
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Log Out Users from an Application with ZITADEL
|
||||
description: "Terminate user sessions across applications using OpenID Connect Single Logout with ZITADEL for secure logouts"
|
||||
sidebar_label: Logout
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Recommended authorization flows with OpenID Connect (OIDC) and OAuth 2.x
|
||||
description: "Overview of recommended OIDC and OAuth 2.x authorization flows for secure user authentication and resource access"
|
||||
sidebar_label: Recommended authorization flows
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: OpenID Connect and OAuth2 web keys
|
||||
description: "Manage JSON Web Keys (JWKS) in ZITADEL to sign and verify tokens during OIDC and OAuth 2.0 authorization flows"
|
||||
sidebar_label: Web Keys
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Authenticate users with SAML
|
||||
description: "Integrate SAML Single Sign-On (SSO) in your applications using ZITADEL as an Identity Provider (IdP)."
|
||||
sidebar_label: SAML
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Onboard B2B customers using organizations
|
||||
description: "Create and set up new organizations in ZITADEL to onboard B2B customers with multi-tenancy separation of teams or groups"
|
||||
sidebar_label: Onboard B2B customer
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Onboard Users
|
||||
description: "Onboard end-users with ZITADEL by enabling self-registration, manual user invites or automated provisioning using OIDC and external IdPs"
|
||||
sidebar_label: Onboard Users
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Retrieve User Roles in ZITADEL
|
||||
description: "Methods for retrieving assigned user roles and authorizations for projects and organizations via ZITADEL APIs."
|
||||
sidebar_label: Retrieve User Roles
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: SCIM Provisioning from Okta
|
||||
description: "Configure SCIM provisioning from Okta to ZITADEL for automated user management and synchronization of identity records"
|
||||
---
|
||||
|
||||
This guide provides step-by-step instructions to configure SCIM provisioning from Okta into ZITADEL.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Authenticate service accounts and client applications
|
||||
description: "Detailed guide to authenticating service accounts in ZITADEL using Private Key JWT or Client Credentials for machine-to-machine security."
|
||||
sidebar_label: Authenticate service accounts
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Configure client credential authentication for service accounts
|
||||
description: "Authenticate service accounts using the industry-standard OAuth 2.0 Client Credentials flow."
|
||||
sidebar_label: Client credential authentication
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Configure personal access token authentication for service accounts
|
||||
description: "Generate and manage Personal Access Tokens (PAT) for service accounts to enable non-interactive API access to ZITADEL."
|
||||
sidebar_label: Personal access token authentication
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Configure private key JWT authentication for service accounts
|
||||
description: "Use RFC 7523 Private Key JWT authentication for secure, certificate-based service account login in ZITADEL."
|
||||
sidebar_label: Private key JWT authentication
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Log in with ZITADEL on Atlassian through SAML 2.0
|
||||
description: "Configure SAML 2.0 on Atlassian with ZITADEL as an external Identity Provider for Single Sign-On (SSO)"
|
||||
sidebar_label: Atlassian
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Log in with ZITADEL on Auth0 through OIDC
|
||||
description: "Connect Auth0 to ZITADEL using OIDC to enable secure login with custom authentication logic and OpenID Connect tokens"
|
||||
sidebar_label: Auth0 (OIDC)
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Log in with ZITADEL on Auth0 through SAML 2.0
|
||||
description: "Configure a SAML 2.0 connection between Auth0 and ZITADEL to enable login with ZITADEL on Auth0 using enterprise connections"
|
||||
sidebar_label: Auth0 (SAML)
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Log in with ZITADEL on AWS through SAML 2.0
|
||||
description: "Enable SAML 2.0 Single Sign-On for AWS IAM Identity Center (formerly AWS SSO) using ZITADEL as the identity provider."
|
||||
sidebar_label: Amazon Web Services
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Configure ZITADEL as an OIDC Identity Provider on Cloudflare Zero Trust
|
||||
description: "Configure ZITADEL as an OIDC Identity Provider on Cloudflare Zero Trust with custom user info and authentication flows"
|
||||
sidebar_label: Cloudflare Zero Trust
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Log in with ZITADEL on Gitlab through SAML 2.0
|
||||
description: "Configure SAML 2.0 Single Sign-On for GitLab using ZITADEL as the Identity Provider."
|
||||
sidebar_label: Gitlab
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Log in with ZITADEL on Gitlab OmniAuth Provider
|
||||
description: "Enable OIDC-based login for self-hosted GitLab instances using ZITADEL as the OmniAuth provider."
|
||||
---
|
||||
|
||||
import CreateApp from "../application/_application.mdx";
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Log in with ZITADEL on Google Cloud with Workforce Identity Federation (OIDC)
|
||||
description: "Configure Workforce Identity Federation with ZITADEL to log in users and assign roles on Google Cloud using OIDC claims"
|
||||
sidebar_label: Google Cloud
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Google Workspace SSO with ZITADEL
|
||||
description: "Configure ZITADEL as the SAML 2.0 Identity Provider (IdP) for Single Sign-On (SSO) in Google Workspace."
|
||||
sidebar_label: Google Workspace
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Integrate ZITADEL with your Favorite Services"
|
||||
description: "With the guides in this section you will learn how to integrate ZITADEL with your services."
|
||||
description: "Step-by-step guides for integrating ZITADEL with popular services and tools including Google Workspace, AWS, Atlassian, Cloudflare, GitLab, and many other software solutions."
|
||||
---
|
||||
|
||||
{/* THIS FILE IS AUTO-GENERATED FROM SIDEBAR-DATA.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Log in with ZITADEL on Ping Identity through SAML 2.0
|
||||
description: "Configure SAML 2.0 connection between Ping Identity and ZITADEL to enable login with ZITADEL on Ping Identity"
|
||||
sidebar_label: Ping Identity
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Impersonation and delegation using Token Exchange
|
||||
description: "Exchange tokens with different scopes, audiences, or subjects using RFC 8693 OAuth 2.0 Token Exchange grant and ZITADEL"
|
||||
sidebar_label: Token Exchange
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Basic Authentication in ZITADEL
|
||||
description: "Authenticate with ZITADEL's token introspection endpoint using Basic Authentication (client secret basic)"
|
||||
sidebar_label: Basic Authentication
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Token introspection
|
||||
sidebar_label: Token introspection
|
||||
description: Integrate OAuth 2.0 token introspection to verify access token validity in resource servers
|
||||
---
|
||||
|
||||
import DocCardList from '@/components/docusaurus/doc-card-list';
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Private Key JWT
|
||||
description: "Authenticate with ZITADEL's token introspection endpoint using Private Key JWT to validate access tokens"
|
||||
sidebar_label: Private Key JWT
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Apache 2.0
|
||||
description: "Configure OpenID Connect with Apache 2.0 and ZITADEL using modauthopenidc to secure routes and handle logout requests"
|
||||
---
|
||||
|
||||
This integration guide shows you the basic OpenID Connect integration with ZITADEL and an Apache 2.0 server.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Access ZITADEL APIs
|
||||
description: "Authenticate and authorize requests to ZITADEL APIs to manage instances, organizations, and user resources."
|
||||
---
|
||||
|
||||
This guide explains what ZITADEL APIs are and how to access ZITADEL APIs using a service account to manage all types of resources and settings.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Access ZITADEL System API
|
||||
description: "Authenticate with the ZITADEL System API using JWT profiles to manage instances and global settings in self-hosted deployments."
|
||||
sidebar_label: System API
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Get Events from ZITADEL
|
||||
description: "Consume and query audit logs and system changes via ZITADEL's Event API for integration, monitoring, and reporting."
|
||||
sidebar_label: Event API
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Integrate ZITADEL APIs into a .NET Application
|
||||
description: "Fetch organization details using ZITADEL management API and .NET SDK with a service account and valid key JSON"
|
||||
sidebar_label: Example .NET
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Integrate ZITADEL APIs into a Go Application
|
||||
description: "Example showing how to call ZITADEL Management APIs from a Go application using service account credentials."
|
||||
sidebar_label: Example Go
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Billing
|
||||
description: "Manage billing, payment methods, and customer details in ZITADEL Cloud."
|
||||
---
|
||||
|
||||
## Billing
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: ZITADEL Cloud Egress IP Addresses
|
||||
sidebar_label: Egress IPs
|
||||
description: A list of static IP addresses ZITADEL Cloud uses to make outbound connections to your services.
|
||||
description: "The static egress IP addresses used by ZITADEL Cloud for secure outbound connections to your infrastructure."
|
||||
---
|
||||
|
||||
When configuring your firewall or network security groups, you may need to allow traffic **from** ZITADEL Cloud to your internal infrastructure.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: ZITADEL Instances
|
||||
description: "Create and manage multiple ZITADEL instances for dev, test, and production environments in the Customer Portal."
|
||||
sidebar_label: Instances
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Settings
|
||||
description: "Configure your ZITADEL Cloud team settings, including notification preferences and subscriptions."
|
||||
---
|
||||
|
||||
In the settings you can change your team name, notification settings and delete your team.
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Getting Started with ZITADEL
|
||||
description: "Create your ZITADEL Cloud account and first instance."
|
||||
sidebar_label: Getting Started
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: ZITADEL Support
|
||||
description: "Submit a support request to ZITADEL's customer portal with required information for timely assistance."
|
||||
sidebar_label: Customer Support
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Customer Portal Administrators
|
||||
description: "Manage administrators who have access to the ZITADEL Customer Portal."
|
||||
sidebar_label: Customer Portal Administrators
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Actions
|
||||
description: "Extend ZITADEL with custom JavaScript logic using Actions."
|
||||
sidebar_label: Overview
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: ZITADEL Administrators
|
||||
description: "Manage administrators and their roles within ZITADEL instances and organizations."
|
||||
sidebar_label: Administrators
|
||||
---
|
||||
|
||||
@@ -58,7 +59,7 @@ InternalAuthZ:
|
||||
- "iam.write"
|
||||
```
|
||||
|
||||
# Administrator Permission Matrix
|
||||
## Administrator Permission Matrix
|
||||
|
||||
This table is generated dynamically from our settings file.
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Applications
|
||||
description: "Create and configure applications in ZITADEL to enable secure OIDC or SAML authentication."
|
||||
sidebar_label: Applications
|
||||
|
||||
sidebar_position: 5
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Management Console
|
||||
description: "Overview of the ZITADEL Management Console for identity and access management tasks."
|
||||
sidebar_label: Management Console
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: ZITADEL Default Settings
|
||||
description: "Configure default settings in ZITADEL to establish fallback organizational settings for features, branding, and authentication preferences"
|
||||
sidebar_label: Default Settings
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Organizations
|
||||
description: "Manage organizations, data isolation, and branding within ZITADEL."
|
||||
sidebar_label: Organizations
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Organize applications, services, and roles with projects
|
||||
description: "Use projects to group applications and manage roles and authorizations across multiple clients."
|
||||
sidebar_label: Projects
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user