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

Docs: add name claim to jwt docs #713

Merged
merged 4 commits into from
Jun 20, 2023
Merged

Conversation

ZPain8464
Copy link
Contributor

This PR adds the name claim to the getting-users-identity.md page.

It also removes the step to create a custom name claim to be sent with jwt_claims_headers in the Grafana guide.

As for other docs to update:

  • Go docs: I can also update the GO SDK docs, but not sure where to do so.
  • The JWT SDK guides both use iss and aud claims to verify the JWT, so the name claim isn't necessary to mention.

Fixes #685

@ZPain8464 ZPain8464 requested a review from a team as a code owner June 14, 2023 18:44
@ZPain8464 ZPain8464 requested review from cmo-pomerium and removed request for a team June 14, 2023 18:44
@netlify
Copy link

netlify bot commented Jun 14, 2023

Deploy Preview for pomerium-docs ready!

Name Link
🔨 Latest commit c8840eb
🔍 Latest deploy log https://app.netlify.com/sites/pomerium-docs/deploys/648a0ba912b8750008cbdbb5
😎 Deploy Preview https://deploy-preview-713--pomerium-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@kenjenkins
Copy link
Contributor

Re: Go SDK docs, that should wait on a change to the Go SDK itself (pomerium/sdk-go#93).

@ZPain8464
Copy link
Contributor Author

Based on this Slack thread, the GO SDK inline docs don't need any updates.

Copy link
Contributor

@kenjenkins kenjenkins left a 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)
Copy link
Contributor

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.

Copy link
Contributor Author

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.

Copy link
Contributor

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.

@ZPain8464 ZPain8464 merged commit 40d51a8 into main Jun 20, 2023
7 checks passed
@ZPain8464 ZPain8464 deleted the zpain/add-name-claim-to-jwt-docs branch June 20, 2023 13:50
backport-actions-token bot pushed a commit that referenced this pull request Jun 20, 2023
* adds name claim to getting-users-identity.md

* updates decoded jwt sn

* updates grafana guide

* runs prettier and adds unknown word to cspell
ZPain8464 added a commit that referenced this pull request Jun 20, 2023
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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: incomplete entries for name claim
2 participants