diff --git a/content/docs/guides/oauth-integration.md b/content/docs/guides/oauth-integration.md index 29c05e4db1..dd22ebc216 100644 --- a/content/docs/guides/oauth-integration.md +++ b/content/docs/guides/oauth-integration.md @@ -4,27 +4,11 @@ enableTableOfContents: true updatedOn: '2025-05-30T16:54:40.477Z' --- -You can integrate your application or service with Neon using OAuth. The Neon OAuth integration enables your application to interact with Neon user accounts, carrying out permitted actions on their behalf. Our integration does not require direct access to user login credentials and is conducted with their approval, ensuring data privacy and security. +The Neon OAuth integration enables your application to interact with Neon user accounts, carrying out permitted actions on their behalf. Our integration does not require direct access to user login credentials and is conducted with their approval, ensuring data privacy and security. -To set up the integration and create a Neon OAuth application, you can apply on our [Partners page](/partners). You will need to provide the following information: - -- Your name and email address (this should be an individual email address, not a shared inbox address) -- Your company name -- Details about your application, including your application name, what it does, and a link to the website. -- Callback URL(s), which are used to redirect users after completing the authorization flow. - - ```text - https://app.company.com/api/integrations/neon/callback - https://app.stage.company.com/api/integrations/neon/callback - http://localhost:3000/api/integrations/neon/callback - ``` - -- Required scopes, defining the type of access you need. We provide scopes for managing both projects and organizations. For a list of all available scopes, see [Supported OAuth Scopes](#supported-oauth-scopes). - -- Whether or not you will make API calls from a backend. -- A logo to be displayed on Neon's OAuth consent dialog when users authorize your application to access their Neon account. - -After your application is reviewed, Neon will provide you with a **client ID** and, if applicable, a **client secret**. Client secrets are only provided for backend clients, so non-backend applications (e.g. browser-based apps or CLI tools) will not receive a secret. These credentials are sensitive and should be stored securely. + +We only provide OAuth integrations for partners we have active commercial relationships with. If you already partner with Neon, the information below documents our OAUth integration. Reach out to your Neon point of contact if you have any questions. + ## How the OAuth integration works @@ -127,7 +111,7 @@ Let's now go through the full flow, step by step: To initiate the OAuth flow, you need to generate an authorization URL. You can do that by directing your users to `https://oauth2.neon.tech/oauth2/auth` while passing the following query parameters: - `client_id`: your OAuth application's ID (provided to you by Neon after your application is received) -- `redirect_uri`: the full URL that Neon should redirect users to after authorizing your application. The URL should match at least one of the callback URLs you provided when applying to become a partner. +- `redirect_uri`: the full URL that Neon should redirect users to after authorizing your application. The URL should match at least one of the callback URLs you provided when setting up your OAuth application. - `scope`: This is a space-separated list of predefined scopes that define the level of access you want to request. For a full list of supported scopes and their meanings, see the [Supported OAuth Scopes](#supported-oauth-scopes) section. **Example:** @@ -171,7 +155,7 @@ After successfully completing the authorization flow, the user is redirected to You can now exchange the authorization code returned from the previous step for an access token. To do that, you need to send a `POST` request to `https://oauth2.neon.tech/oauth2/token` with the following parameters: - `client_id`: your OAuth application's ID. -- `redirect_uri`: the full URL that Neon should redirect users to after authorizing your application. The URL should match at least one of the callback URLs you provided when applying to become a partner. +- `redirect_uri`: the full URL that Neon should redirect users to after authorizing your application. The URL should match at least one of the callback URLs you provided when setting up your OAuth application. - `client_secret`: your OAuth application's secret - `grant_type`: set this to `authorization_code` to indicate that you are using the [Authorization Code grant type](https://oauth.net/2/grant-types/authorization-code/) - `code`: the authorization code returned from the previous step diff --git a/public/llms/guides-oauth-integration.txt b/public/llms/guides-oauth-integration.txt index e328349b62..bbdd857e2a 100644 --- a/public/llms/guides-oauth-integration.txt +++ b/public/llms/guides-oauth-integration.txt @@ -6,39 +6,9 @@ - [Neon OAuth integration HTML](https://neon.com/docs/guides/oauth-integration): The original HTML version of this documentation -You can integrate your application or service with Neon using OAuth. The Neon OAuth integration enables your application to interact with Neon user accounts, carrying out permitted actions on their behalf. Our integration does not require direct access to user login credentials and is conducted with their approval, ensuring data privacy and security. +The Neon OAuth integration enables your application to interact with Neon user accounts, carrying out permitted actions on their behalf. Our integration does not require direct access to user login credentials and is conducted with their approval, ensuring data privacy and security. -To set up the integration and create a Neon OAuth application, you can apply on our [Partners page](https://neon.com/partners). You will need to provide the following information: - -- Your name and email address (this should be an individual email address, not a shared inbox address) -- Your company name -- Details about your application, including your application name, what it does, and a link to the website. -- Callback URL(s), which are used to redirect users after completing the authorization flow. - - ```text - https://app.company.com/api/integrations/neon/callback - https://app.stage.company.com/api/integrations/neon/callback - http://localhost:3000/api/integrations/neon/callback - ``` - -- Required scopes, defining the type of access you need. We provide scopes for managing both projects and organizations. For a list of all available scopes, see [Supported OAuth Scopes](https://neon.com/docs/guides/oauth-integration#supported-oauth-scopes). - -- Whether or not you will make API calls from a backend. -- A logo to be displayed on Neon's OAuth consent dialog when users authorize your application to access their Neon account. - -After your application is reviewed, Neon will provide you with a **client ID** and, if applicable, a **client secret**. Client secrets are only provided for backend clients, so non-backend applications (e.g. browser-based apps or CLI tools) will not receive a secret. These credentials are sensitive and should be stored securely. - -## How the OAuth integration works - -Here is a high-level overview of how Neon's OAuth implementation works: - - - -1. The user sends a request to your API endpoint to initiate the OAuth flow by clicking a button or link in your application. -2. An authorization URL is generated. -3. The user is redirected to Neon's OAuth consent screen to authorize the application. -4. The user logs in and authorizes the application, granting it the necessary permissions. -5. A redirect is performed to a callback endpoint, which includes an access token that allows the application to manage Neon resources on the user's behalf. +We only provide OAuth integrations for partners we have active commercial relationships with. If you already partner with Neon, the information below documents our OAUth integration. Reach out to your Neon point of contact if you have any questions. ## About the Neon OAuth server @@ -127,7 +97,7 @@ Let's now go through the full flow, step by step: To initiate the OAuth flow, you need to generate an authorization URL. You can do that by directing your users to `https://oauth2.neon.tech/oauth2/auth` while passing the following query parameters: - `client_id`: your OAuth application's ID (provided to you by Neon after your application is received) -- `redirect_uri`: the full URL that Neon should redirect users to after authorizing your application. The URL should match at least one of the callback URLs you provided when applying to become a partner. +- `redirect_uri`: the full URL that Neon should redirect users to after authorizing your application. The URL should match at least one of the callback URLs you provided when setting up your OAuth application. - `scope`: This is a space-separated list of predefined scopes that define the level of access you want to request. For a full list of supported scopes and their meanings, see the [Supported OAuth Scopes](https://neon.com/docs/guides/oauth-integration#supported-oauth-scopes) section. **Example:** @@ -169,7 +139,7 @@ After successfully completing the authorization flow, the user is redirected to You can now exchange the authorization code returned from the previous step for an access token. To do that, you need to send a `POST` request to `https://oauth2.neon.tech/oauth2/token` with the following parameters: - `client_id`: your OAuth application's ID. -- `redirect_uri`: the full URL that Neon should redirect users to after authorizing your application. The URL should match at least one of the callback URLs you provided when applying to become a partner. +- `redirect_uri`: the full URL that Neon should redirect users to after authorizing your application. The URL should match at least one of the callback URLs you provided when setting up your OAuth application. - `client_secret`: your OAuth application's secret - `grant_type`: set this to `authorization_code` to indicate that you are using the [Authorization Code grant type](https://oauth.net/2/grant-types/authorization-code/) - `code`: the authorization code returned from the previous step