mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-13 21:01:21 +08:00
13fccd32b6
Some checks failed
all-good: Did all the other checks pass? / all-good (push) Has been cancelled
Ensure Prisma migrations are in sync with the schema / check_prisma_migrations (22.x) (push) Has been cancelled
DB migration compat / Check if migrations changed (push) Has been cancelled
Docker Server Build and Push / Docker Build and Push Server (push) Has been cancelled
Docker Server Build and Run / docker (push) Has been cancelled
Runs E2E API Tests (Local Emulator) / E2E Tests (Local Emulator, Node ${{ matrix.node-version }}) (22.x) (push) Has been cancelled
Runs E2E API Tests / E2E Tests (Node ${{ matrix.node-version }}, Freestyle ${{ matrix.freestyle-mode }}) (mock, 22.x) (push) Has been cancelled
Runs E2E API Tests / E2E Tests (Node ${{ matrix.node-version }}, Freestyle ${{ matrix.freestyle-mode }}) (prod, 22.x) (push) Has been cancelled
Runs E2E API Tests with custom port prefix / build (22.x) (push) Has been cancelled
Lint & build / lint_and_build (latest) (push) Has been cancelled
Dev Environment Test With Custom Base Port / restart-dev-and-test-with-custom-base-port (push) Has been cancelled
Dev Environment Test / restart-dev-and-test (push) Has been cancelled
Run setup tests with custom base port / setup-tests-with-custom-base-port (push) Has been cancelled
Run setup tests / setup-tests (push) Has been cancelled
TOC Generator / TOC Generator (push) Has been cancelled
DB migration compat / Back-compat — Current branch migrations with ${{ needs.check-migrations-changed.outputs.base_branch }} branch code (push) Has been cancelled
DB migration compat / Forward-compat — Current branch code with ${{ needs.check-migrations-changed.outputs.base_branch }} branch migrations (push) Has been cancelled
DB migration compat / No migration changes (skipped) (push) Has been cancelled
78 lines
1.9 KiB
Plaintext
78 lines
1.9 KiB
Plaintext
---
|
|
title: "OAuth Authorize"
|
|
description: "Initiate the OAuth authorization flow for user authentication or provider linking."
|
|
api: "GET /auth/oauth/authorize/{provider_id}"
|
|
---
|
|
|
|
## Description
|
|
|
|
Initiates the OAuth authorization flow for user authentication or provider linking. This endpoint manages two key workflows: authenticating users through OAuth providers and linking existing accounts to OAuth providers.
|
|
|
|
## Path Parameters
|
|
|
|
<ParamField path="provider_id" type="string" required>
|
|
OAuth provider identifier.
|
|
</ParamField>
|
|
|
|
## Query Parameters
|
|
|
|
<ParamField query="type" type="string">
|
|
The type of OAuth flow.
|
|
</ParamField>
|
|
|
|
<ParamField query="token" type="string">
|
|
Authentication token.
|
|
</ParamField>
|
|
|
|
<ParamField query="provider_scope" type="string">
|
|
Provider-specific scope.
|
|
</ParamField>
|
|
|
|
<ParamField query="error_redirect_uri" type="string">
|
|
URI to redirect to on error.
|
|
</ParamField>
|
|
|
|
<ParamField query="after_callback_redirect_url" type="string">
|
|
Target URL after OAuth callback.
|
|
</ParamField>
|
|
|
|
<ParamField query="client_id" type="string">
|
|
OAuth client identifier.
|
|
</ParamField>
|
|
|
|
<ParamField query="client_secret" type="string">
|
|
OAuth client secret.
|
|
</ParamField>
|
|
|
|
<ParamField query="redirect_uri" type="string">
|
|
Redirect URI for OAuth flow.
|
|
</ParamField>
|
|
|
|
<ParamField query="scope" type="string">
|
|
OAuth scopes requested.
|
|
</ParamField>
|
|
|
|
<ParamField query="state" type="string">
|
|
State parameter for security.
|
|
</ParamField>
|
|
|
|
<ParamField query="grant_type" type="string">
|
|
The grant type for the OAuth flow.
|
|
</ParamField>
|
|
|
|
<ParamField query="code_challenge" type="string">
|
|
PKCE code challenge.
|
|
</ParamField>
|
|
|
|
<ParamField query="code_challenge_method" type="string">
|
|
PKCE challenge method.
|
|
</ParamField>
|
|
|
|
<ParamField query="response_type" type="string">
|
|
The response type for the OAuth flow.
|
|
</ParamField>
|
|
|
|
## Response
|
|
|
|
**Status Code:** `302` - Redirect to OAuth provider authorization page
|