Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updates to doc for zdew/ext-jwt-signer #1002

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

updates to doc for zdew/ext-jwt-signer #1002

wants to merge 3 commits into from

Conversation

dovholuknf
Copy link
Member

initial PR for ZDEW doc around external jwt providers

@dovholuknf dovholuknf requested review from a team as code owners December 20, 2024 19:47
Copy link

vercel bot commented Dec 20, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
ziti-doc ✅ Ready (Inspect) Visit Preview Dec 20, 2024 8:27pm

channels are not meant for direct use and using them outside of the overall tunneler is discouraged.

### The Data Service
The data service is the main workhorse of the ZDEW. It is built around the `ziti-tunneler-sdk-c` (and subsequently the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ziti-tunneler-sdk-c doesn't mean much to many readers without a link or context. Maybe we should refer to it generically as the Ziti tunneler SDK or link to the repo if we want people to learn this comparatively obscure project name. Readers are more likely to be familiar with zitie-dge-tunnel, and the daylight between them is slim.

@@ -0,0 +1,17 @@
## Configuring External Auth in OpenZiti
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about a link to next steps assuming they want to do this

* jwks-endpoint - a URL used by the OpenZiti Controller to verify the provided JWT
* claims-property to match (often `email`). The JWT must contain a claim with the provided value
* scopes - additional scopes to request from the provider. Often `email` or `profile`
* external-auth-url - the URL users are directed to for authentication with the external provider
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* external-auth-url - the URL users are directed to for authentication with the external provider
* external-auth-url - the URL users are directed to for authentication with the external provider
[Learn more about external JWT signers](/learn/core-concepts/security/authentication/50-external-jwt-signers.md)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants