Skip to content

feat: add tip to separate invite from recovery#2616

Open
zepatrik wants to merge 1 commit into
ory:masterfrom
simi:docs/invite-users-return-to
Open

feat: add tip to separate invite from recovery#2616
zepatrik wants to merge 1 commit into
ory:masterfrom
simi:docs/invite-users-return-to

Conversation

@zepatrik

@zepatrik zepatrik commented Jun 9, 2026

Copy link
Copy Markdown
Member

No description provided.

Copilot AI review requested due to automatic review settings June 9, 2026 08:31
@CLAassistant

CLAassistant commented Jun 9, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@zepatrik zepatrik changed the title docs: added tip to separate invite from recovery feat: add tip to separate invite from recovery Jun 9, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the Kratos “Invite users” documentation to suggest using a return_to parameter as a way to differentiate first-time invitations from regular password recovery, by carrying context into the recovery/settings flows.

Changes:

  • Adds a new :::tip explaining return_to, including an example request and guidance on using it for invitation branding.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +94 to +96
Add a `return_to` query parameter to control where the user lands after they set their
credentials. The target URL must be allow-listed in `selfservice.allowed_return_urls`
(see [Browser redirects](../concepts/browser-redirect-flow-completion.mdx)).
@simi

simi commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

Adds a tip to the Invite users guide showing how to pass return_to on POST /admin/recovery/link, so admins can control where an invited user lands after setting credentials — and brand a first-time invitation differently from a normal password reset (e.g. ?return_to=…?source=invitation).

return_to on this endpoint is supported but undocumented on the page where people implementing invitations actually look. It was added to the API spec in ory/kratos#3711 and requested in ory/kratos#3084, yet the invite-users guide never mentioned it. This closes that doc gap and notes the allowed_return_urls allow-list requirement.

@simi simi force-pushed the docs/invite-users-return-to branch from 3612d82 to 0660d6b Compare June 9, 2026 09:57
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.

4 participants