From bf1ad045fe06597cca236a96feb42c4b95a2927e Mon Sep 17 00:00:00 2001 From: Sarah Edwards Date: Fri, 24 Feb 2023 08:22:22 -0800 Subject: [PATCH] Document the callback URL for GitHub Apps (#34999) Co-authored-by: James Martin Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com> --- ...out-the-user-authorization-callback-url.md | 20 +++++++++++++++++++ .../creating-github-apps/index.md | 1 + 2 files changed, 21 insertions(+) create mode 100644 content/apps/creating-github-apps/creating-github-apps/about-the-user-authorization-callback-url.md diff --git a/content/apps/creating-github-apps/creating-github-apps/about-the-user-authorization-callback-url.md b/content/apps/creating-github-apps/creating-github-apps/about-the-user-authorization-callback-url.md new file mode 100644 index 0000000000..71ee616c30 --- /dev/null +++ b/content/apps/creating-github-apps/creating-github-apps/about-the-user-authorization-callback-url.md @@ -0,0 +1,20 @@ +--- +title: About the user authorization callback URL +intro: 'You can specify a URL that users will be redirected to after they authorize an app.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - GitHub Apps +shortTitle: Callback URL +--- + +When you create a {% data variables.product.prodname_github_app %}, you can specify a callback URL. When you use the web application flow to identify and authorize users, users will be redirected to the callback URL after they authorize the app. + +You can specify up to 10 callback URLs. If you specify multiple callback URLs, you can use the `redirect_uri` parameter when you identify and authorize a user to indicate which callback URL the user should be redirected to. If you do not specify `redirect_uri`, the first callback URL will be used. + +The callback URL is different from the setup URL. Users are redirected to the setup URL after they install an app. Users are redirected to the callback URL when they authorize an app via the web application flow. + +For more information about identifying and authorizing users, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/identifying-and-authorizing-users-for-github-apps#parameters)". For more information about creating a {% data variables.product.prodname_github_app %}, see "[AUTOTITLE](/apps/creating-github-apps/creating-github-apps/creating-a-github-app)." diff --git a/content/apps/creating-github-apps/creating-github-apps/index.md b/content/apps/creating-github-apps/creating-github-apps/index.md index 484948e97f..73e19ab228 100644 --- a/content/apps/creating-github-apps/creating-github-apps/index.md +++ b/content/apps/creating-github-apps/creating-github-apps/index.md @@ -20,4 +20,5 @@ children: - /creating-a-github-app-from-a-manifest - /creating-a-github-app-using-url-parameters - /creating-a-custom-badge-for-your-github-app + - /about-the-user-authorization-callback-url ---