Skip to content

Commit

Permalink
feat: add base_redirect_url documentation (#1516)
Browse files Browse the repository at this point in the history
  • Loading branch information
jonas-jonas authored Aug 30, 2023
1 parent d72a01f commit 0c638bb
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions docs/identities/sign-in/social-sign-in/redirect-url.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,33 @@ title: Set custom domain as redirect URL
sidebar_label: Custom domain redirect
---

```mdx-code-block
import Tabs from "@theme/Tabs"
import TabItem from "@theme/TabItem"
```

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)

:::caution

Changing the `base_redirect_uri` will break previously existing and functional social sign-in connections.
This setting applies to all social sign-in providers (new and existing) and cannot be changed on a per-provider basis. So,
changing the `base_redirect_uri` will break previously existing and functional social sign-in connections, because Ory Identities
will initiate the OIDC flow with the new redirect URL.

:::

````mdx-code-block
<Tabs>
<TabItem value="console" label="Ory Console" default>
To use a custom domain as the redirect URL, go to the [OpenID Connect (OIDC)](https://console.ory.sh/projects/current/social-signin) page and click **Show advanced settings** and add the domain to the **Base Redirect URI**.
</TabItem>
<TabItem value="cli" label="Ory CLI">
To change the redirect URL to your custom domain, you need to update the `base_redirect_uri`:
```shell
Expand All @@ -24,7 +40,10 @@ ory list projects
## Add OIDC base redirect URI
ory patch identity-config <project-id> \
--add '/selfservice/methods/oidc/config/base_redirect_uri="https://ory.example.org"'
```
````

</TabItem>
</Tabs>

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:
Expand Down

0 comments on commit 0c638bb

Please sign in to comment.