Skip to content
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.

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

fix(docs): Match user token update and prioritize internal integrations #7918

Merged
merged 4 commits into from
Sep 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file removed src/api/auth-token.png
Binary file not shown.
4 changes: 2 additions & 2 deletions src/api/permissions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ different API endpoints.

To set the scopes for an [integration token](/product/integrations/integration-platform/#permissions), select the scopes from the dropdown. These can be edited later.

To set the scopes for an auth token, check the necessary boxes when [creating an auth token](https://sentry.io/api/).
To set the scopes for an auth token, select the scopes from the dropdown when [creating an auth token](https://sentry.io/api/). These cannot be edited later.

![](auth-token.png)
![](../docs/product/accounts/auth-tokens/user-auth-token-create.png)

If you're looking for information on membership roles please visit the
[membership](/product/accounts/membership/) documentation.
Expand Down
26 changes: 13 additions & 13 deletions src/docs/product/accounts/auth-tokens/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,26 +21,26 @@ There are three key types of auth tokens in Sentry:
- [Organization Auth Tokens](#organization-auth-tokens):
These tokens are bound to an organization, and have access to all projects within that organization. They have a limited set of permissions and are designed to be used in CI environments and with Sentry CLI.

- [User Auth Tokens](#user-auth-tokens):
These tokens are bound to a user, and have access to all organizations and projects that user has access to.

- [Internal Integrations](#internal-integrations):
These tokens are bound to an organization, and have access to all projects within that organization. They can be created with a custom set of permissions, and are designed to be used in cases where organization auth tokens don't have sufficient access rights.

- [User Auth Tokens](#user-auth-tokens):
These tokens are bound to a user, and have access to all organizations and projects that user has access to.

### When Should I Use Which?

For most scenarios, we recommend using [Organization Auth Tokens](#organization-auth-tokens). They are designed to be used in CI environments and have a limited set of permissions. This means that if the place you stored the auth token is compromised, the attacker can only do limited damage.

Organization auth tokens permissions aren't customizable. They are set to allow most CI-related tasks, without any unnecessary permissions.

[User Auth Tokens](#user-auth-tokens) should be used to interact with the Sentry API on behalf of a user. For example, to fetch all issues for a user, you would use a User auth token. We don't recommend using User auth tokens for CI tasks because if the user who created the token is removed from the Organization, the token will stop working.

User auth token permissions are customizable and editable.

[Internal Integrations](#internal-integrations) should be used when you need full API access (which the organization auth tokens cannot grant), and you want to interact with the Sentry API on behalf of an organization. For example, to programmatically create a new project, you would use an internal integration.

Permissions for auth tokens created as part of an internal integration are customizable and editable.

[User Auth Tokens](#user-auth-tokens) should be used to interact with the Sentry API on behalf of a user. For example, to fetch all issues for a user, you would use a user auth token. We don't recommend using user auth tokens for CI tasks because if the user who created the token is removed from the Organization, the token will stop working.

User auth token permissions are customizable but cannot be edited later.

### Organization Auth Tokens

[Organization auth tokens](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/) can be created in [sentry.io](https://sentry.io) on the **Auth Tokens** page under **Settings > Developer Settings > Auth Tokens**.
Expand All @@ -59,6 +59,12 @@ Any user can create organization auth tokens for any of their organizations. Thi

All owners of the organization will receive a security email when a new organization auth token is created and can revoke these tokens at any point. _Only_ organization owners & managers can revoke organization auth tokens .

### Internal Integrations

We recommend only using an internal integration when you want to interact with the Sentry API on behalf of an organization. See Sentry's API [Authentication](/api/auth/) docs for more information on how to do this.

To get started, see our docs on [Internal Integrations](/product/integrations/integration-platform/).

### User Auth Tokens

[User auth tokens](https://sentry.io/settings/account/api/auth-tokens/) can be created in [sentry.io](https://sentry.io) on the **User Auth Tokens** page under the Account dropdown in the top left.
Expand All @@ -76,9 +82,3 @@ Currently, you can view user auth tokens in the UI after creating them. This is
![](user-auth-tokens-overview.png)

We recommend only using a user auth token to interact with the Sentry API on behalf of a user. See Sentry's API [Authentication](/api/auth/) docs for more information on how to do this.

### Internal Integrations

We recommend only using an internal integration when you want to interact with the Sentry API on behalf of an organization. See Sentry's API [Authentication](/api/auth/) docs for more information on how to do this.

See our docs on [Internal Integrations](/product/integrations/integration-platform/) to learn more.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading