-
-
Notifications
You must be signed in to change notification settings - Fork 374
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: document how to customize redirect url (#1509)
* feat: document how to customize redirect url * Update docs/identities/sign-in/social-sign-in/redirect-url.mdx Co-authored-by: Alano Terblanche <[email protected]> * Update docs/identities/sign-in/social-sign-in/redirect-url.mdx Co-authored-by: Vincent <[email protected]> * fix: redirect url doc * fix: text bugs --------- Co-authored-by: Alano Terblanche <[email protected]> Co-authored-by: Vincent <[email protected]> Co-authored-by: Vincent Kraus <[email protected]>
- Loading branch information
1 parent
f00afaf
commit 4df6a1c
Showing
3 changed files
with
45 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
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. 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. | ||
|
||
::: | ||
|
||
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"' | ||
``` | ||
|
||
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.
This file contains 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