-
Notifications
You must be signed in to change notification settings - Fork 16
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
Docs: add name claim to jwt docs #713
Conversation
✅ Deploy Preview for pomerium-docs ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
Re: Go SDK docs, that should wait on a change to the Go SDK itself (pomerium/sdk-go#93). |
Based on this Slack thread, the GO SDK inline docs don't need any updates. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice catch on the Grafana guide!
@@ -139,7 +140,7 @@ Though you will likely verify signed headers programmatically in your applicatio | |||
|
|||
1. Finally, we want to cryptographically verify the validity of the token. To do this, we will need the signer's public key. You can simply copy and past the output of `cat ec_public.pem`. | |||
|
|||
![httpbin displaying verified jwt](./img/verifying-headers-2.png) | |||
![httpbin displaying verified jwt](./img/jwt-payload.png) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder if we should update the other two screenshots as well (and maybe the instructions too — I'm not sure our deploy examples include httpbin anymore, so I don't know whether people reading this would be able to follow along easily).
If you think this is worthwhile maybe you could file a follow-up issue? I'd be happy to help.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@kenjenkins we do use httpbin in some other guides in the docs, but I don't think anyone would have a problem updating the screenshots in this guide. And sure, let's address updating the images in this follow-up issue.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for filing an issue! Sounds good to me.
* adds name claim to getting-users-identity.md * updates decoded jwt sn * updates grafana guide * runs prettier and adds unknown word to cspell
Docs: add name claim to jwt docs (#713) * adds name claim to getting-users-identity.md * updates decoded jwt sn * updates grafana guide * runs prettier and adds unknown word to cspell Co-authored-by: zachary painter <[email protected]>
This PR adds the
name
claim to thegetting-users-identity.md
page.It also removes the step to create a custom
name
claim to be sent withjwt_claims_headers
in the Grafana guide.As for other docs to update:
iss
andaud
claims to verify the JWT, so thename
claim isn't necessary to mention.Fixes #685