mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-11 19:07:30 +00:00
docs(guide): cloudflare zero trust (#6345)
This commit is contained in:
@@ -39,7 +39,6 @@ export default function CreateApp(props) {
|
||||
/>
|
||||
<h3>Review your configuration</h3>
|
||||
<ReviewConfig appType={props.appType} authType={props.authType} />
|
||||
<h3>Create key for private key JWT</h3>
|
||||
<GenerateKey appType={props.appType} authType={props.authType} />
|
||||
</div>
|
||||
);
|
||||
|
@@ -3,6 +3,7 @@ import ThemedImage from "@theme/ThemedImage";
|
||||
export default function GenerateKey(props) {
|
||||
return props.appType == "api" || props.authType == "jwt" ? (
|
||||
<div>
|
||||
<h3>Create key for private key JWT</h3>
|
||||
<p>
|
||||
After you successfully created your application with authentication type
|
||||
JWT your can create keys in the Configuration section and Keys Card of
|
||||
|
54
docs/docs/guides/integrate/services/cloudflare-oidc.mdx
Normal file
54
docs/docs/guides/integrate/services/cloudflare-oidc.mdx
Normal file
@@ -0,0 +1,54 @@
|
||||
---
|
||||
title: Configure as OIDC Identity Provider for Cloudflare Zero Trust
|
||||
sidebar_label: Cloudflare Zero Trust
|
||||
---
|
||||
|
||||
import CreateApp from "../application/_application.mdx";
|
||||
|
||||
This guide shows how to configure ZITADEL as OpenID Connect identity provider for Cloudflare Zero Trust.
|
||||
|
||||
Prerequisites:
|
||||
|
||||
- Existing ZITADEL instance, organization, and project. Follow our [get started](/guides/start/quickstart) guide to get started. If not present follow [this guide](/guides/start/quickstart)
|
||||
- Existing Cloudflare account and [team domain](https://developers.cloudflare.com/cloudflare-one/glossary/#team-domain)
|
||||
|
||||
## Create the client in ZITADEL
|
||||
|
||||
<CreateApp appType="web" authType="code" appName="Cloudflare" redirectURI="https://<your-team-name>.cloudflareaccess.com/cdn-cgi/access/callback"/>
|
||||
|
||||
## Send user info in tokens
|
||||
|
||||
Make sure to enable "User Info inside ID Token" on your application settings.
|
||||
|
||||

|
||||
|
||||
:::info
|
||||
Cloudflare will return an error "User email was not returned. API permissions are likely incorrect". Enable to send the user information inside the token on your client settings.
|
||||
:::
|
||||
|
||||
## Configure Cloudflare Zero Trust Authentication
|
||||
|
||||
1. On the Cloudflare dashboard go to Zero Trust, click settings, and then select "Authentication"
|
||||
2. Add a new login method with the type "OpenID Connect"
|
||||
3. Fill in the required information. Check the discovery endpoint of your instance (https://{your_domain}/.well-known/openid-configuration) for the urls. As mentioned in the Cloudflare docs the Certificate Url is jwks_uri.
|
||||
4. Disable PKCE (Cloudflare requires a client secret for PKCE, which is currently not supported)
|
||||
5. Add the following claims: "openid", "profile", "email"
|
||||
6. Test the connection
|
||||
|
||||
### Example configuration
|
||||
|
||||
```json
|
||||
{
|
||||
"config": {
|
||||
"client_id": "<your client id>",
|
||||
"client_secret": "<your client secret>",
|
||||
"auth_url": "https://{your_domain}.zitadel.cloud/oauth/v2/authorize",
|
||||
"token_url": "https://{your_domain}.zitadel.cloud/oauth/v2/token",
|
||||
"certs_url": "https://{your_domain}.zitadel.cloud/oauth/v2/keys",
|
||||
"scopes": ["openid", "email", "profile"],
|
||||
"pkce_enabled": false,
|
||||
},
|
||||
"type": "oidc",
|
||||
"name": "Generic Google"
|
||||
}
|
||||
```
|
@@ -276,6 +276,7 @@ module.exports = {
|
||||
collapsed: true,
|
||||
items: [
|
||||
"guides/integrate/services/gitlab-self-hosted",
|
||||
"guides/integrate/services/cloudflare-oidc",
|
||||
"guides/integrate/services/aws-saml",
|
||||
"guides/integrate/services/google-cloud",
|
||||
"guides/integrate/services/atlassian-saml",
|
||||
|
BIN
docs/static/img/guides/integrate/services/user-info-inside-id-token.png
vendored
Normal file
BIN
docs/static/img/guides/integrate/services/user-info-inside-id-token.png
vendored
Normal file
Binary file not shown.
After Width: | Height: | Size: 220 KiB |
Reference in New Issue
Block a user