Skip to content

Commit 2827611

Browse files
waleedlatif1waleedlatif1
authored
feat(docs): OAuth scopes section on each integration page (#8382)
* feat(docs): OAuth scopes section on each integration page * fix(docs): correct Cal.com legacy OAuth client requirement
1 parent 536e9f6 commit 2827611

59 files changed

Lines changed: 1560 additions & 146 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

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

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -266,8 +266,6 @@ Get the schema of all tables, fields, and views in an Airtable base
266266
| `tables` | json | Array of table schemas with fields and views |
267267
| `metadata` | json | Operation metadata including total tables count |
268268

269-
270-
271269
## Triggers
272270

273271
A **Trigger** is a block that starts a workflow when an event happens in this service.
@@ -316,3 +314,22 @@ Trigger workflow from Airtable record changes like create, update, and delete ev
316314
| ↳ `changeType` | string | Type of change \(created, changed, destroyed\) |
317315
| ↳ `cellValuesByFieldId` | object | Cell values by field ID |
318316

317+
318+
## OAuth Scopes
319+
320+
Sim requests these scopes when someone connects an Airtable account. On a self-hosted deployment, register your own app with the provider using the settings below. See [Integrations & OAuth](/platform/self-hosting/integrations-oauth) for the full setup.
321+
322+
| Setting | Value |
323+
| ------- | ----- |
324+
| Redirect URI | `<NEXT_PUBLIC_APP_URL>/api/auth/oauth2/callback/airtable` |
325+
| Environment variables | `AIRTABLE_CLIENT_ID`, `AIRTABLE_CLIENT_SECRET` |
326+
327+
| Scope | Description |
328+
| ----- | ----------- |
329+
| `data.records:read` | Read records |
330+
| `data.records:write` | Create, edit, and delete records |
331+
| `schema.bases:read` | View bases and tables |
332+
| `user.email:read` | Read email address |
333+
| `webhook:manage` | Create, view, and delete base webhooks and read their payloads |
334+
335+

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -382,4 +382,17 @@ List all sections in an Asana project
382382
| ↳ `name` | string | Section name |
383383
| ↳ `resource_type` | string | Resource type \(section\) |
384384

385+
## OAuth Scopes
386+
387+
Sim requests these scopes when someone connects an Asana account. On a self-hosted deployment, register your own app with the provider using the settings below. See [Integrations & OAuth](/platform/self-hosting/integrations-oauth) for the full setup.
388+
389+
| Setting | Value |
390+
| ------- | ----- |
391+
| Redirect URI | `<NEXT_PUBLIC_APP_URL>/api/auth/oauth2/callback/asana` |
392+
| Environment variables | `ASANA_CLIENT_ID`, `ASANA_CLIENT_SECRET` |
393+
394+
| Scope | Description |
395+
| ----- | ----------- |
396+
| `default` | Full access to everything the account can reach in Asana |
397+
385398

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

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1224,8 +1224,6 @@ Update an attribute (schema field) on an Attio object or list
12241224
| `config` | json | Type-dependent attribute configuration |
12251225
| `createdAt` | string | When the attribute was created |
12261226

1227-
1228-
12291227
## Triggers
12301228

12311229
A **Trigger** is a block that starts a workflow when an event happens in this service.
@@ -1727,3 +1725,26 @@ Trigger workflow when a new member is added to the Attio workspace
17271725
| `workspaceId` | string | The workspace ID |
17281726
| `workspaceMemberId` | string | The workspace member ID |
17291727

1728+
1729+
## OAuth Scopes
1730+
1731+
Sim requests these scopes when someone connects an Attio account. On a self-hosted deployment, register your own app with the provider using the settings below. See [Integrations & OAuth](/platform/self-hosting/integrations-oauth) for the full setup.
1732+
1733+
| Setting | Value |
1734+
| ------- | ----- |
1735+
| Redirect URI | `<NEXT_PUBLIC_APP_URL>/api/auth/oauth2/callback/attio` |
1736+
| Environment variables | `ATTIO_CLIENT_ID`, `ATTIO_CLIENT_SECRET` |
1737+
1738+
| Scope | Description |
1739+
| ----- | ----------- |
1740+
| `record_permission:read-write` | Read and write CRM records |
1741+
| `object_configuration:read-write` | Read and manage object schemas |
1742+
| `list_configuration:read-write` | Read and manage list configurations |
1743+
| `list_entry:read-write` | Read and write list entries |
1744+
| `note:read-write` | Read and write notes |
1745+
| `task:read-write` | Read and write tasks |
1746+
| `comment:read-write` | Read and write comments and threads |
1747+
| `user_management:read` | View workspace members |
1748+
| `webhook:read-write` | Manage webhooks |
1749+
1750+

‎apps/docs/content/docs/integrations/bitbucket.mdx‎

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1545,8 +1545,6 @@ Read a bounded UTF-8 tail of a pipeline step log
15451545
| `truncated` | boolean | Whether earlier log output was omitted |
15461546
| `totalBytes` | number | Full log byte size when reported |
15471547

1548-
1549-
15501548
## Triggers
15511549

15521550
A **Trigger** is a block that starts a workflow when an event happens in this service.
@@ -2215,3 +2213,25 @@ Trigger workflow when a Bitbucket repository is updated
22152213
| `payload` | json | Full parsed Bitbucket webhook payload |
22162214
| `changes` | json | Repository fields changed by the update |
22172215

2216+
2217+
## OAuth Scopes
2218+
2219+
Sim requests these scopes when someone connects a Bitbucket account. On a self-hosted deployment, register your own app with the provider using the settings below. See [Integrations & OAuth](/platform/self-hosting/integrations-oauth) for the full setup.
2220+
2221+
| Setting | Value |
2222+
| ------- | ----- |
2223+
| Redirect URI | `<NEXT_PUBLIC_APP_URL>/api/auth/oauth2/callback/bitbucket` |
2224+
| Environment variables | `BITBUCKET_CLIENT_ID`, `BITBUCKET_CLIENT_SECRET` |
2225+
2226+
| Scope | Description |
2227+
| ----- | ----------- |
2228+
| `account` | View your Bitbucket account and workspace memberships |
2229+
| `repository` | View repositories and source code |
2230+
| `repository:write` | Push to repositories and create or delete branches |
2231+
| `pullrequest` | View and comment on pull requests |
2232+
| `pullrequest:write` | Create, update, approve, decline, and merge pull requests |
2233+
| `pipeline` | View pipelines, steps, and logs |
2234+
| `pipeline:write` | Run and stop pipelines |
2235+
| `webhook` | Manage repository webhooks |
2236+
2237+

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -416,4 +416,18 @@ Resend a Box Sign request to signers who have not yet signed
416416
| --------- | ---- | ----------- |
417417
| `message` | string | Success confirmation message |
418418

419+
## OAuth Scopes
420+
421+
Sim requests these scopes when someone connects a Box account. On a self-hosted deployment, register your own app with the provider using the settings below. See [Integrations & OAuth](/platform/self-hosting/integrations-oauth) for the full setup.
422+
423+
| Setting | Value |
424+
| ------- | ----- |
425+
| Redirect URI | `<NEXT_PUBLIC_APP_URL>/api/auth/oauth2/callback/box` |
426+
| Environment variables | `BOX_CLIENT_ID`, `BOX_CLIENT_SECRET` |
427+
428+
| Scope | Description |
429+
| ----- | ----------- |
430+
| `root_readwrite` | Read and write all files and folders in Box account |
431+
| `sign_requests.readwrite` | Create and manage Box Sign e-signature requests |
432+
419433

‎apps/docs/content/docs/integrations/calcom.mdx‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -764,8 +764,6 @@ Get available booking slots for a Cal.com event type within a time range
764764
| `status` | string | Response status |
765765
| `data` | json | Available time slots grouped by date \(YYYY-MM-DD keys\). Each date maps to an array of slot objects with start time, optional end time, and seated event info. |
766766

767-
768-
769767
## Triggers
770768

771769
A **Trigger** is a block that starts a workflow when an event happens in this service.
@@ -1135,3 +1133,14 @@ Trigger workflow on any Cal.com webhook event (configure event types in Cal.com)
11351133
| `createdAt` | string | When the webhook event was created \(ISO 8601\) |
11361134
| `payload` | json | Complete webhook payload \(structure varies by event type\) |
11371135

1136+
1137+
## OAuth Scopes
1138+
1139+
Sim requests no OAuth scopes for Cal.com. On a self-hosted deployment, register your own app with the provider using the settings below. See [Integrations & OAuth](/platform/self-hosting/integrations-oauth) for the full setup.
1140+
1141+
| Setting | Value |
1142+
| ------- | ----- |
1143+
| Redirect URI | `<NEXT_PUBLIC_APP_URL>/api/auth/oauth2/callback/calcom` |
1144+
| Environment variables | `CALCOM_CLIENT_ID` |
1145+
1146+

‎apps/docs/content/docs/integrations/clickup.mdx‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -804,8 +804,6 @@ Get the currently running time entry in a ClickUp workspace (null when no timer
804804
| --------- | ---- | ----------- |
805805
| `timeEntry` | json | The running time entry \(duration is negative while running\); null when no timer is running |
806806

807-
808-
809807
## Triggers
810808

811809
A **Trigger** is a block that starts a workflow when an event happens in this service.
@@ -1587,3 +1585,14 @@ Trigger workflow on any ClickUp event (subscribes to all events)
15871585
| `folderId` | string | ID of the affected folder \(folder events only\) |
15881586
| `spaceId` | string | ID of the affected space \(space events only\) |
15891587

1588+
1589+
## OAuth Scopes
1590+
1591+
Sim requests no OAuth scopes for ClickUp. On a self-hosted deployment, register your own app with the provider using the settings below. See [Integrations & OAuth](/platform/self-hosting/integrations-oauth) for the full setup.
1592+
1593+
| Setting | Value |
1594+
| ------- | ----- |
1595+
| Redirect URI | `<NEXT_PUBLIC_APP_URL>/api/auth/oauth2/callback/clickup` |
1596+
| Environment variables | `CLICKUP_CLIENT_ID`, `CLICKUP_CLIENT_SECRET` |
1597+
1598+

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

Lines changed: 51 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1376,8 +1376,6 @@ Get display name and profile info for a Confluence user by account ID.
13761376
| `profilePicture` | string | Path to the user profile picture |
13771377
| `publicName` | string | Public name of the user |
13781378

1379-
1380-
13811379
## Triggers
13821380

13831381
A **Trigger** is a block that starts a workflow when an event happens in this service.
@@ -2157,3 +2155,54 @@ Trigger workflow on any Confluence webhook event
21572155
| `user` | json | User object \(present in user events\) |
21582156
| `files` | file[] | Attachment file content \(present in attachment events when includeFileContent is enabled\) |
21592157

2158+
2159+
## OAuth Scopes
2160+
2161+
Sim requests these scopes when someone connects a Confluence account. On a self-hosted deployment, register your own app with the provider using the settings below. See [Integrations & OAuth](/platform/self-hosting/integrations-oauth) for the full setup.
2162+
2163+
| Setting | Value |
2164+
| ------- | ----- |
2165+
| Redirect URI | `<NEXT_PUBLIC_APP_URL>/api/auth/oauth2/callback/confluence` |
2166+
| Environment variables | `CONFLUENCE_CLIENT_ID`, `CONFLUENCE_CLIENT_SECRET` |
2167+
2168+
| Scope | Description |
2169+
| ----- | ----------- |
2170+
| `read:confluence-content.all` | Read all Confluence content |
2171+
| `read:confluence-space.summary` | Read Confluence space information |
2172+
| `read:space:confluence` | View Confluence spaces |
2173+
| `write:confluence-content` | Create and edit Confluence pages, blog posts, and comments |
2174+
| `write:confluence-space` | Manage Confluence spaces |
2175+
| `write:confluence-file` | Upload files to Confluence |
2176+
| `read:page:confluence` | View Confluence pages |
2177+
| `write:page:confluence` | Create and update Confluence pages |
2178+
| `read:comment:confluence` | View comments on Confluence pages |
2179+
| `write:comment:confluence` | Create and update comments |
2180+
| `delete:comment:confluence` | Delete comments from Confluence pages |
2181+
| `delete:attachment:confluence` | Delete attachments from Confluence pages |
2182+
| `delete:page:confluence` | Delete Confluence pages |
2183+
| `read:label:confluence` | View labels on Confluence content |
2184+
| `write:label:confluence` | Add and remove labels |
2185+
| `read:attachment:confluence` | View attachments on Confluence pages |
2186+
| `write:attachment:confluence` | Upload and manage attachments |
2187+
| `search:confluence` | Search Confluence content |
2188+
| `read:me` | Read profile information |
2189+
| `offline_access` | Access account when not using the application |
2190+
| `read:hierarchical-content:confluence` | View page hierarchy \(children and ancestors\) |
2191+
| `read:content.metadata:confluence` | View content metadata \(required for ancestors\) |
2192+
| `read:user:confluence` | View Confluence user profiles |
2193+
| `read:confluence-user` | View Confluence user profiles \(v1 API\) |
2194+
| `read:group:confluence` | View Confluence groups and memberships |
2195+
| `read:task:confluence` | View Confluence inline tasks |
2196+
| `write:task:confluence` | Update Confluence inline tasks |
2197+
| `write:space:confluence` | Create and update Confluence spaces |
2198+
| `delete:space:confluence` | Delete Confluence spaces |
2199+
| `read:blogpost:confluence` | View Confluence blog posts |
2200+
| `write:blogpost:confluence` | Create and update Confluence blog posts |
2201+
| `delete:blogpost:confluence` | Delete Confluence blog posts |
2202+
| `read:content.property:confluence` | View properties on Confluence content |
2203+
| `write:content.property:confluence` | Create and manage content properties |
2204+
| `read:space.property:confluence` | View Confluence space properties |
2205+
| `write:space.property:confluence` | Create and manage space properties |
2206+
| `read:space.permission:confluence` | View Confluence space permissions |
2207+
2208+

‎apps/docs/content/docs/integrations/docusign.mdx‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,4 +216,18 @@ Get the recipient status details for a DocuSign envelope
216216
| ↳ `email` | string | Recipient email |
217217
| ↳ `status` | string | Recipient status |
218218

219+
## OAuth Scopes
220+
221+
Sim requests these scopes when someone connects a DocuSign account. On a self-hosted deployment, register your own app with the provider using the settings below. See [Integrations & OAuth](/platform/self-hosting/integrations-oauth) for the full setup.
222+
223+
| Setting | Value |
224+
| ------- | ----- |
225+
| Redirect URI | `<NEXT_PUBLIC_APP_URL>/api/auth/oauth2/callback/docusign` |
226+
| Environment variables | `DOCUSIGN_CLIENT_ID`, `DOCUSIGN_CLIENT_SECRET` |
227+
228+
| Scope | Description |
229+
| ----- | ----------- |
230+
| `signature` | Send, track, and manage envelopes with the eSignature API |
231+
| `extended` | Keep access active by extending the refresh token lifetime |
232+
219233

‎apps/docs/content/docs/integrations/dropbox.mdx‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -340,4 +340,23 @@ Restore a specific revision of a file to the given path
340340
| ↳ `rev` | string | Revision identifier of the restored file |
341341
| ↳ `server_modified` | string | Server modification time |
342342

343+
## OAuth Scopes
344+
345+
Sim requests these scopes when someone connects a Dropbox account. On a self-hosted deployment, register your own app with the provider using the settings below. See [Integrations & OAuth](/platform/self-hosting/integrations-oauth) for the full setup.
346+
347+
| Setting | Value |
348+
| ------- | ----- |
349+
| Redirect URI | `<NEXT_PUBLIC_APP_URL>/api/auth/oauth2/callback/dropbox` |
350+
| Environment variables | `DROPBOX_CLIENT_ID`, `DROPBOX_CLIENT_SECRET` |
351+
352+
| Scope | Description |
353+
| ----- | ----------- |
354+
| `account_info.read` | View Dropbox account information |
355+
| `files.metadata.read` | View file and folder names, sizes, and dates |
356+
| `files.metadata.write` | Modify file and folder metadata |
357+
| `files.content.read` | Download and read Dropbox files |
358+
| `files.content.write` | Upload, copy, move, and delete files in Dropbox |
359+
| `sharing.read` | View shared files and folders |
360+
| `sharing.write` | Share files and folders with others |
361+
343362

0 commit comments

Comments
 (0)