Skip to content

Commit b2c817e

Browse files
committed
fix(docs): describe a self-issued credential by the kind it actually is
Round two returned the same finding on 14 pages: the one sentence covering self-issued credentials still read as if the scope table were something to apply to them. It cannot be one sentence, because the credential models differ in what is true about them. A Google service account is the sharp case. Its access comes from the key and the domain-wide delegation granted in Workspace, and `getServiceAccountToken` strips the two `userinfo` scopes from the JWT because Google rejects user-identity scopes for a service account. Naming those scopes beside that credential describes access it can never hold. A pasted API token is the opposite: most have no permission picker at all and simply carry their creating account's access, so any instruction to grant something sends the reader looking for a setting that does not exist. Carry the `serviceAccountProviderId` through the docs catalog instead of a boolean, and pick the sentence from it. Neither variant tells the reader to match the table. The excluded identity scopes now live in `scopes.ts` and `credential-service.ts` imports them, so the published claim and the filter that makes it true cannot drift apart. The self-hosting reference gains one line saying what every table on it is: the OAuth flow's request, and so what the app registration must allow. A credential issued by hand is not governed by it.
1 parent 872d91f commit b2c817e

37 files changed

Lines changed: 140 additions & 53 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. 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.
44+
Airtable also accepts a credential you create yourself. Sim cannot request scopes on one, so its access is fixed when you create it, and it is generally whatever the account that created it can already do.
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. 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.
41+
Asana also accepts a credential you create yourself. Sim cannot request scopes on one, so its access is fixed when you create it, and it is generally whatever the account that created it can already do.
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. 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.
49+
Attio also accepts a credential you create yourself. Sim cannot request scopes on one, so its access is fixed when you create it, and it is generally whatever the account that created it can already do.
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. 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.
51+
Box also accepts a credential you create yourself. Sim cannot request scopes on one, so its access is fixed when you create it, and it is generally whatever the account that created it can already do.
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. 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.
76+
Confluence also accepts a credential you create yourself. Sim cannot request scopes on one, so its access is fixed when you create it, and it is generally whatever the account that created it can already do.
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. 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.
49+
Gmail also accepts a Google service account. Its access comes from the key and the domain-wide delegation you grant it in Google Workspace, not from this table, and Sim cannot add to it. The two `userinfo` scopes apply only to an OAuth connection: Google rejects them for a service account, so Sim leaves them out of that token.
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. 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.
42+
Google BigQuery also accepts a Google service account. Its access comes from the key and the domain-wide delegation you grant it in Google Workspace, not from this table, and Sim cannot add to it. The two `userinfo` scopes apply only to an OAuth connection: Google rejects them for a service account, so Sim leaves them out of that token.
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. 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.
46+
Google Calendar also accepts a Google service account. Its access comes from the key and the domain-wide delegation you grant it in Google Workspace, not from this table, and Sim cannot add to it. The two `userinfo` scopes apply only to an OAuth connection: Google rejects them for a service account, so Sim leaves them out of that token.
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. 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.
41+
Google Contacts also accepts a Google service account. Its access comes from the key and the domain-wide delegation you grant it in Google Workspace, not from this table, and Sim cannot add to it. The two `userinfo` scopes apply only to an OAuth connection: Google rejects them for a service account, so Sim leaves them out of that token.
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. 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.
44+
Google Docs also accepts a Google service account. Its access comes from the key and the domain-wide delegation you grant it in Google Workspace, not from this table, and Sim cannot add to it. The two `userinfo` scopes apply only to an OAuth connection: Google rejects them for a service account, so Sim leaves them out of that token.
4545

4646

4747
## Actions

0 commit comments

Comments
 (0)