Skip to content

Commit 872d91f

Browse files
committed
fix(docs): stop the scope tables overstating what a self-issued token grants
Review findings from the first round, all in the generated prose rather than the scope data. Only some self-issued credentials have permissions to pick. An Airtable PAT and a Slack custom bot do; a Wealthbox, Monday or Pipedrive token carries its creating user's access with no picker at all, and a Google service account uses domain-wide delegation over a set the JWT flow filters. Telling every reader to "grant it the same access" sent most of them looking for a setting that does not exist. Say instead that a self-issued credential carries whatever access it was created with. Slack's approval-gated scopes were invisible to a self-hoster. They stay out of the tables so generated output cannot vary by deployment, but anyone who sets `SLACK_EXTENDED_SCOPES` has to add them to the app first, and Slack rejects the entire authorization when the app is not approved for one. Both the integration page and the self-hosting reference now name them and their flag, sourced from a new `ENV_GATED_SCOPES` entry that `getSlackApprovalGatedScopes` also reads, so the prose cannot drift from the grant. `Chat.ReadWrite` and `Mail.ReadWrite` were labelled write-only. Both also read, and these labels show on the consent screen as well as in the docs. Also switch the scopes import in `oauth.ts` to the absolute specifier its sibling OAuth imports use.
1 parent f690e9b commit 872d91f

39 files changed

Lines changed: 125 additions & 47 deletions

apps/docs/content/docs/integrations/airtable.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Connecting Airtable requests these scopes.
4141
| `user.email:read` | Read email address |
4242
| `webhook:manage` | Manage webhooks |
4343

44-
Airtable also accepts a credential you create yourself. Grant it the same access, since Sim can only request scopes on a connection it opens.
44+
Airtable also accepts a credential you create yourself. Sim cannot request scopes on one, so its access is whatever the credential carries: some providers let you select these permissions when you create the token, others give it the creating user's access.
4545

4646

4747
## Actions

apps/docs/content/docs/integrations/asana.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Connecting Asana requests these scopes.
3838
| ----- | ----------- |
3939
| `default` | Access Asana workspace |
4040

41-
Asana also accepts a credential you create yourself. Grant it the same access, since Sim can only request scopes on a connection it opens.
41+
Asana also accepts a credential you create yourself. Sim cannot request scopes on one, so its access is whatever the credential carries: some providers let you select these permissions when you create the token, others give it the creating user's access.
4242

4343

4444
## Actions

apps/docs/content/docs/integrations/attio.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Connecting Attio requests these scopes.
4646
| `user_management:read` | View workspace members |
4747
| `webhook:read-write` | Manage webhooks |
4848

49-
Attio also accepts a credential you create yourself. Grant it the same access, since Sim can only request scopes on a connection it opens.
49+
Attio also accepts a credential you create yourself. Sim cannot request scopes on one, so its access is whatever the credential carries: some providers let you select these permissions when you create the token, others give it the creating user's access.
5050

5151

5252
## Actions

apps/docs/content/docs/integrations/box.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Connecting Box requests these scopes.
4848
| `root_readwrite` | Read and write all files and folders in Box account |
4949
| `sign_requests.readwrite` | Create and manage Box Sign e-signature requests |
5050

51-
Box also accepts a credential you create yourself. Grant it the same access, since Sim can only request scopes on a connection it opens.
51+
Box also accepts a credential you create yourself. Sim cannot request scopes on one, so its access is whatever the credential carries: some providers let you select these permissions when you create the token, others give it the creating user's access.
5252

5353

5454
## Actions

apps/docs/content/docs/integrations/confluence.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Connecting Confluence requests these scopes.
7373
| `write:space.property:confluence` | Create and manage space properties |
7474
| `read:space.permission:confluence` | View Confluence space permissions |
7575

76-
Confluence also accepts a credential you create yourself. Grant it the same access, since Sim can only request scopes on a connection it opens.
76+
Confluence also accepts a credential you create yourself. Sim cannot request scopes on one, so its access is whatever the credential carries: some providers let you select these permissions when you create the token, others give it the creating user's access.
7777

7878

7979
## Actions

apps/docs/content/docs/integrations/gmail.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Connecting Gmail requests these scopes.
4646
| `https://www.googleapis.com/auth/gmail.modify` | View and manage email messages |
4747
| `https://www.googleapis.com/auth/gmail.labels` | View and manage email labels |
4848

49-
Gmail also accepts a credential you create yourself. Grant it the same access, since Sim can only request scopes on a connection it opens.
49+
Gmail also accepts a credential you create yourself. Sim cannot request scopes on one, so its access is whatever the credential carries: some providers let you select these permissions when you create the token, others give it the creating user's access.
5050

5151

5252
## Actions

apps/docs/content/docs/integrations/google_bigquery.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Connecting Google BigQuery requests these scopes.
3939
| `https://www.googleapis.com/auth/userinfo.profile` | View basic profile info |
4040
| `https://www.googleapis.com/auth/bigquery` | View and manage data in Google BigQuery |
4141

42-
Google BigQuery also accepts a credential you create yourself. Grant it the same access, since Sim can only request scopes on a connection it opens.
42+
Google BigQuery also accepts a credential you create yourself. Sim cannot request scopes on one, so its access is whatever the credential carries: some providers let you select these permissions when you create the token, others give it the creating user's access.
4343

4444

4545
## Actions

apps/docs/content/docs/integrations/google_calendar.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Connecting Google Calendar requests these scopes.
4343
| `https://www.googleapis.com/auth/userinfo.profile` | View basic profile info |
4444
| `https://www.googleapis.com/auth/calendar` | View and manage calendar |
4545

46-
Google Calendar also accepts a credential you create yourself. Grant it the same access, since Sim can only request scopes on a connection it opens.
46+
Google Calendar also accepts a credential you create yourself. Sim cannot request scopes on one, so its access is whatever the credential carries: some providers let you select these permissions when you create the token, others give it the creating user's access.
4747

4848

4949
## Actions

apps/docs/content/docs/integrations/google_contacts.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Connecting Google Contacts requests these scopes.
3838
| `https://www.googleapis.com/auth/userinfo.profile` | View basic profile info |
3939
| `https://www.googleapis.com/auth/contacts` | View and manage Google Contacts |
4040

41-
Google Contacts also accepts a credential you create yourself. Grant it the same access, since Sim can only request scopes on a connection it opens.
41+
Google Contacts also accepts a credential you create yourself. Sim cannot request scopes on one, so its access is whatever the credential carries: some providers let you select these permissions when you create the token, others give it the creating user's access.
4242

4343

4444
## Actions

apps/docs/content/docs/integrations/google_docs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Connecting Google Docs requests these scopes.
4141
| `https://www.googleapis.com/auth/drive.file` | View and manage Google Drive files |
4242
| `https://www.googleapis.com/auth/drive` | Access all Google Drive files |
4343

44-
Google Docs also accepts a credential you create yourself. Grant it the same access, since Sim can only request scopes on a connection it opens.
44+
Google Docs also accepts a credential you create yourself. Sim cannot request scopes on one, so its access is whatever the credential carries: some providers let you select these permissions when you create the token, others give it the creating user's access.
4545

4646

4747
## Actions

0 commit comments

Comments
 (0)