Skip to content

add registration doc #16546

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rodolfoBee wants to merge 1 commit into
base: master
Choose a base branch
from
Open

add registration doc #16546

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/api/auth.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ The endpoints that require a user authentication token are specific to your user

For third-party applications that need to access Sentry on behalf of users, Sentry supports OAuth2 with the authorization code grant type. This allows users to authorize your application without sharing their credentials.

Before implementing OAuth, Sentry must register your application. Please follow the steps on [this page](/product/partnership-platform/oauth-integration/#partner-registration) to complete your registration.

### Authorization Request

Direct users to the authorization endpoint:
Expand All @@ -45,7 +47,7 @@ https://sentry.io/oauth/authorize/?client_id={CLIENT_ID}&response_type=code&scop
| `client_id` | Yes | Your registered client ID |
| `response_type` | Yes | Must be `code` |
| `scope` | Yes | Space-separated list of [permissions](/api/permissions/) |
| `redirect_uri` | No | Your callback URI (must match registered URI) |
| `redirect_uri` | Yes | Your callback URI (must match registered URI) |
| `state` | No | Random string to prevent CSRF attacks |
| `code_challenge` | Recommended | PKCE challenge (see below) |
| `code_challenge_method` | Recommended | Must be `S256` |
Expand Down
Loading