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: document how to customize redirect url #1509

Merged
merged 5 commits into from
Aug 22, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions docs/identities/sign-in/social-sign-in/redirect-url.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
id: redirect-url
title: Set custom domain as redirect URL
sidebar_label: Custom domain redirect
---

Some Social Sign-in Providers such as Google or GitHub show the Redirect URL as part of the sign-in process:

![GitHub showing the redirect URL](redirect-url/callback.png)

By default, Ory Network uses a redirect URL that points to the Ory Network domain.

:::caution

Changing the `base_redirect_uri` will break previously existing and functional social sign-in connections.

To fix a broken connection, choose the provider you want to fix from the Ory Console social sign-in configuration screen and copy
the updated redirect URL which now points to your custom hostname. Use the value you copied to update the redirect URL
configuration of the social sign-in provider.
aeneasr marked this conversation as resolved.
Show resolved Hide resolved

:::

This makes it easy to get started with Social Sign-in. To adjust the redirect URL to your custom domain, you need to update the
`base_redirect_uri`:

```shell
## List all available projects
ory list projects

## Remove the configuration entry
ory patch identity-config <project-id> \
--add '/selfservice/methods/oidc/config/base_redirect_uri="https://ory.example.org"'
```
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions src/sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ module.exports = {
],
},
"kratos/social-signin/get-tokens",
"identities/sign-in/social-sign-in/redirect-url",
"kratos/social-signin/data-mapping",
"kratos/social-signin/account-linking",
"kratos/social-signin/native-apps",
Expand Down
Loading