docs: document oauth2_login_request in courier template data#2669
Open
hperl wants to merge 1 commit into
Open
Conversation
Kratos now includes a scoped oauth2_login_request object (challenge and the client's client_id, client_name, client_uri, logo_uri, metadata) in the login_code_valid, registration_code_valid, verification_code_valid, and verification_valid template data when the flow was started through an OAuth2 login challenge. Documents the Go template variable and the HTTP courier template_data field. See ory-corp/cloud#12776. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Documents newly available OAuth2 login request context passed into Ory Kratos courier templates, so users can brand emails/webhook payloads based on the initiating OAuth2 client.
Changes:
- Extend the HTTP mail courier
template_datadocs to include an optionaloauth2_login_requestobject (plus thelogin_code_valid/registration_code_validtemplate types). - Document the
OAuth2LoginRequestGo template variable (and its client fields) for relevant custom email templates.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/kratos/self-hosted/03_mail-courier-http.mdx | Adds oauth2_login_request to documented HTTP courier template_data and includes an example payload. |
| docs/kratos/emails-sms/05_custom-email-templates.mdx | Documents the OAuth2LoginRequest variable for Go email templates with a field reference table and usage example. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Kratos courier templates now receive a scoped
oauth2_login_requestobject (challenge plus the initiating client'sclient_id,client_name,client_uri,logo_uri, andmetadata) when a flow was started through an OAuth2 login challenge. This documents:OAuth2LoginRequestGo template variable on the custom email templates page, andoauth2_login_requestfield in the HTTP couriertemplate_data(including the previously undocumentedlogin_code_validandregistration_code_validtypes).Feature PR: ory-corp/cloud#12776 (ships with the next Kratos release).
🤖 Generated with Claude Code