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

feat: update webhook documentation with more grant types #1241

Merged
merged 4 commits into from
Apr 25, 2023

Conversation

sgal
Copy link
Contributor

@sgal sgal commented Feb 4, 2023

Related Issue or Design Document

Documentation update for ory/hydra#3427.

This change adds guides for adding/updating custom token claims via webhook feature for the following set of grant types:

  • authorization_code
  • client_credentials
  • refresh_token
  • urn:ietf:params:oauth:client-assertion-type:jwt-bearer

Checklist

  • I have read the contributing guidelines and signed the CLA.
  • I have referenced an issue containing the design document if my change introduces a new feature.
  • I have read the security policy.
  • I confirm that this pull request does not address a security vulnerability.
    If this pull request addresses a security vulnerability,
    I confirm that I got approval (please contact security@ory.sh) from the maintainers to push the changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added the necessary documentation within the code base (if appropriate).

Further comments

@sgal
Copy link
Contributor Author

sgal commented Feb 4, 2023

docs/hydra/guides/custom-token-claims.mdx Outdated Show resolved Hide resolved
docs/hydra/guides/custom-token-claims.mdx Outdated Show resolved Hide resolved
docs/hydra/guides/custom-token-claims.mdx Outdated Show resolved Hide resolved
docs/hydra/guides/custom-token-claims.mdx Outdated Show resolved Hide resolved
src/sidebar.js Outdated Show resolved Hide resolved
@vinckr vinckr changed the title Update webhook documentation with more grant types feat: update webhook documentation with more grant types Mar 2, 2023
@sgal sgal force-pushed the update-hook-docs-grant-types-payload branch 2 times, most recently from d937177 to f415823 Compare March 3, 2023 12:45
@sgal
Copy link
Contributor Author

sgal commented Mar 3, 2023

@tomekpapiernik Thanks for the review. I reverted the document ID and the sidebar changes and fixed the writing. Please have a look.

@tomekpapiernik
Copy link
Contributor

Thanks for updating your PR @sgal ! I took the liberty of editing this a bit more. Most important change - I updated the Ory CLI to use --add instead of --replace, as the keys you want to work with aren't present in the oauth2 config from the get-go - they must be added. The --replace command doesn't do that. I'll approve this PR and it can be merged along with the code PR you opened.

tomekpapiernik
tomekpapiernik previously approved these changes Mar 6, 2023
@sgal
Copy link
Contributor Author

sgal commented Mar 6, 2023

@tomekpapiernik Thanks a lot for the review and fixes 👏

@sgal
Copy link
Contributor Author

sgal commented Apr 24, 2023

@aeneasr The PR in Hydra is already merged, shall we merge this as well?

Copy link
Collaborator

@hperl hperl left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for your contribution @sgal!

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.

3 participants