Skip to content

update README with latest scope names #39

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.

Sign up for GitHub

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

Open
figmolly wants to merge 3 commits into
base: main
Choose a base branch
from
+13 −5
Open

update README with latest scope names #39

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d0a09a3
update README with latest scope names
figmolly Oct 20, 2025
53c3506
clarify which scopes are for what
figmolly Oct 20, 2025
bdaa6bc
point to the right docs for each scope
figmolly Oct 20, 2025
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
18 changes: 13 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,20 @@ Whether you’re looking to use SDS to start a new project, or are looking for e

### Figma Auth

- [Create a Figma API token](https://www.figma.com/developers/api#authentication)
- Add Code Connect scope
- Add File Read, Dev Resources Write, and Variables scopes if you want to use the integrations in [scripts](./scripts/)
- [More on scopes](https://www.figma.com/developers/api#authentication-scopes)
- [Create a Figma API token](https://www.figma.com/developers/api#authentication) and request the following scopes to work with Code Connect
- ```file_code_connect_scope:write``` - to work with Code Connect
- [More on Code Connect scopes](https://developers.figma.com/docs/code-connect/quickstart-guide/#before-you-begin)

and these scopes, if you want to use the integrations in [scripts](./scripts/)
- ```file_dev_resources:read```- Read dev resources in files.
- ```file_dev_resources:write``` - Write dev resources to files
- ```file_variables:read``` - Read variables in files. Note: Enterprise plan only.
- ```file_variables:write``` - Write variables and collections in files. Note: Enterprise plan only.
- ```file_metadata:read``` - Read metadata of files.
- ```file_versions:read``` - Read the version history for files you can access.
- [More on REST API scopes](https://www.figma.com/developers/api#authentication-scopes)
- Duplicate [.env-rename](./.env-rename)
- Rename it to `.env`, it will be ignored from git.
- Rename it to `.env`, it will be ignored by git.
- Set `FIGMA_ACCESS_TOKEN=` as your token in `.env`
- Set `FIGMA_FILE_KEY=` as your file's key (grab it from the file URL) in `.env`

Expand Down