Skip to content

Commit

Permalink
fix: redirect url doc
Browse files Browse the repository at this point in the history
  • Loading branch information
vinckr committed Aug 22, 2023
1 parent 0887033 commit 5fa4d21
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 10 deletions.
31 changes: 21 additions & 10 deletions docs/identities/sign-in/social-sign-in/redirect-url.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,41 @@ 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:
Some Social Sign-in Providers such as Google or GitHub show the Redirect URL as part of the sign-in process. By default, Ory
Network uses a redirect URL that points to the Ory Network domain:

![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 redirect URL. You need to replace the Ory Network URL with your custom hostname. Use this URL to update the redirect URL
configuration of the social sign-in provider.

:::

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`:
To change 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"'
--add '/selfservice/methods/oidc/config/base_redirect_uri="https://ory.ory.example.org"'
```

After changing the base redirect URI you need to update the redirect URL of social sign-in providers you want to use. This is done
in the configuration of the social sign-in provider. To update an existing social sign in provider, follow these steps:

1. Open the Ory Console and navigate to the social sign-in configuration screen.
1. Choose the provider you want to fix and click on the configuration button.
1. Copy the **Redirect URI** from the form.
1. Replace the Ory Network URL `{project-slug}.projects.oryapis.com` with your custom hostname, such as `ory.example.org`.
1. Update the Redirect URI - also called Authorization callback URL - in the social sign-in provider configuration.

:::info

Make sure the Redirect URI matches the hostname you configured in the Ory Network configuration. For example when your custom
hostname is `https://ory.example.org`, the Redirect URI needs to be `https://ory.example.org`, not `https://www.ory.example.org`
or `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.

0 comments on commit 5fa4d21

Please sign in to comment.