Skip to content

Commit 39aab18

Browse files
ArthurKnausbitsandfoxes
authored andcommitted
ref(settings): Rename auth tokens (#13914)
Rename `Auth Token` and `User Auth Token` to `Organization Token` and `Personal Token` respectively. Update screenshots on affected pages. - part of [TET-556: Merge sections and rename Auth Tokens and User Auth Tokens](https://linear.app/getsentry/issue/TET-556/merge-sections-and-rename-auth-tokens-and-user-auth-tokens) - requires getsentry/sentry#92803
1 parent c033e0c commit 39aab18

File tree

28 files changed

+50
-50
lines changed

28 files changed

+50
-50
lines changed
Loading
Loading
Loading
Loading
Loading

docs/account/auth-tokens/index.mdx

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -18,32 +18,32 @@ We recommend using a separate auth token for each use case. For example, you wou
1818

1919
There are three key types of auth tokens in Sentry:
2020

21-
- [Organization Auth Tokens](#organization-auth-tokens):
21+
- [Organization Tokens](#organization-tokens):
2222
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.
2323

2424
- [Internal Integrations](#internal-integrations):
25-
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.
25+
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 tokens don't have sufficient access rights.
2626

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

3030
### When Should I Use Which?
3131

32-
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.
32+
For most scenarios, we recommend using [Organization Tokens](#organization-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.
3333

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

36-
[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.
36+
[Internal Integrations](#internal-integrations) should be used when you need full API access (which the organization 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.
3737

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

40-
[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.
40+
[Personal Tokens](#personal-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 personal token. We don't recommend using personal tokens for CI tasks because if the user who created the token is removed from the Organization, the token will stop working.
4141

42-
User auth token permissions are customizable but cannot be edited later.
42+
Personal token permissions are customizable but cannot be edited later.
4343

44-
### Organization Auth Tokens
44+
### Organization Tokens
4545

46-
[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**.
46+
[Organization 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 > Organization Tokens**.
4747

4848
![](./img/org-auth-tokens-overview.png)
4949

@@ -53,36 +53,36 @@ They can also be generated on certain pages of Sentry's docs if you're signed in
5353

5454
</Alert>
5555

56-
Organization auth token names are generated for you unless you create the token through the Sentry UI. This name is only used for display purposes - it helps to identify an auth token in case you want to revoke it later. You can change the name for an organization auth token at [sentry.io](https://sentry.io) on the **Edit Auth Token** page under **Settings > Developer Settings > Auth Tokens**.
56+
Organization token names are generated for you unless you create the token through the Sentry UI. This name is only used for display purposes - it helps to identify an auth token in case you want to revoke it later. You can change the name for an organization token at [sentry.io](https://sentry.io) on the **Edit Auth Token** page under **Settings > Developer Settings > Organization Tokens**.
5757

58-
For security reasons, organization auth tokens are only visible _once_, right after you create them. If you lose the auth token, you will have to create a new one. This means you can't see the full token on the overview page or on the token detail page, you can only see the last characters of the token to help identify it.
58+
For security reasons, organization tokens are only visible _once_, right after you create them. If you lose the auth token, you will have to create a new one. This means you can't see the full token on the overview page or on the token detail page, you can only see the last characters of the token to help identify it.
5959

60-
Any user can create organization auth tokens for any of their organizations. This allows any user (not only organization owners) to configure a Sentry SDK and set up CI processes by creating and using organization auth tokens. Since organization auth tokens have limited access, there is limited potential for abuse.
60+
Any user can create organization tokens for any of their organizations. This allows any user (not only organization owners) to configure a Sentry SDK and set up CI processes by creating and using organization tokens. Since organization tokens have limited access, there is limited potential for abuse.
6161

6262
![](./img/org-auth-token-create.png)
6363

64-
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 .
64+
All owners of the organization will receive a security email when a new organization token is created and can revoke these tokens at any point. _Only_ organization owners & managers can revoke organization tokens .
6565

6666
### Internal Integrations
6767

6868
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.
6969

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

72-
### User Auth Tokens
72+
### Personal Tokens
7373

74-
[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.
74+
[Personal tokens](https://sentry.io/settings/account/api/auth-tokens/) can be created in [sentry.io](https://sentry.io) on the **Personal Tokens** page under the Account dropdown in the top left.
7575

7676
![](./img/user-auth-tokens-menu.png)
7777

78-
User auth tokens can be created by any user, and are bound to that user. The tokens can be given permissions to all organizations and projects that user has access to. This means a user auth token's _maximum_ scope is all the scopes that the user has access to for a given organization. A user auth token cannot exceed the permissions of the user who created it. See [Organization and User Management](/organization/membership/) for more details on how permissions work in Sentry.
78+
Personal tokens can be created by any user, and are bound to that user. The tokens can be given permissions to all organizations and projects that user has access to. This means a personal token's _maximum_ scope is all the scopes that the user has access to for a given organization. A personal token cannot exceed the permissions of the user who created it. See [Organization and User Management](/organization/membership/) for more details on how permissions work in Sentry.
7979

80-
When you create a new user auth token, you can select which [scopes](/api/permissions/) the token should have in the UI:
80+
When you create a new personal token, you can select which [scopes](/api/permissions/) the token should have in the UI:
8181

8282
![](./img/user-auth-token-create.png)
8383

84-
Currently, you can view user auth tokens in the UI after creating them. This is a legacy behavior that may change in the future. We recommend only using each user auth token once, and creating a new token for each use case. Any user can always revoke any of their user auth tokens.
84+
Currently, you can view personal tokens in the UI after creating them. This is a legacy behavior that may change in the future. We recommend only using each personal token once, and creating a new token for each use case. Any user can always revoke any of their personal tokens.
8585

8686
![](./img/user-auth-tokens-overview.png)
8787

88-
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.
88+
We recommend only using a personal 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.

docs/api/auth.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ You can create authentication tokens within Sentry by [creating an internal inte
2323

2424
### User authentication tokens
2525

26-
Some API endpoints require an authentication token that's associated with your user account, rather than an authentication token from an internal integration. These auth tokens can be created within Sentry on the "User settings" page (**User settings > User Auth Tokens**) and assigned specific scopes.
26+
Some API endpoints require an authentication token that's associated with your user account, rather than an authentication token from an internal integration. These auth tokens can be created within Sentry on the "User settings" page (**User settings > Personal Tokens**) and assigned specific scopes.
2727

2828
The endpoints that require a user authentication token are specific to your user, such as [Retrieve an Organization](/api/organizations/retrieve-an-organization/).
2929

docs/api/guides/create-auth-token.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ See our documentation on [authentication](/api/auth/) to learn more about the di
1313

1414
## Create an Internal Integration
1515

16-
[Internal integrations](/organization/integrations/integration-platform/internal-integration/) are used to create custom Sentry integrations for your organization. They can also be used to create and manage your organization auth tokens.
16+
[Internal integrations](/organization/integrations/integration-platform/internal-integration/) are used to create custom Sentry integrations for your organization. They can also be used to create and manage your organization tokens.
1717

1818
1. Open [sentry.io](https://sentry.io/)
1919

docs/api/guides/teams-tutorial.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ APIs used in this tutorial:
1414

1515
- A Sentry authentication token with team:write scopes or higher and project:read scopes or higher.
1616

17-
> If you don't have an authentication token, follow the [Create a Sentry Authentication Token](/api/guides/create-auth-token) tutorial to create an organization auth token with the following permissions, or higher:
17+
> If you don't have an authentication token, follow the [Create a Sentry Authentication Token](/api/guides/create-auth-token) tutorial to create an organization token with the following permissions, or higher:
1818
>
1919
> - Organization: Read
2020
> - Team: Write
28.6 KB
Loading

0 commit comments

Comments
 (0)