Skip to content

Commit 9020764

Browse files
docs: rewrite a section about permissions in api-keys.mdx (#300)
* Update api-keys.mdx * Add files via upload
1 parent dcc2131 commit 9020764

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

public/capgo_apikeys_diagram.webp

19 KB
Loading

src/content/docs/docs/public-api/api-keys.mdx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,17 @@ API keys are used to authenticate requests to the Capgo API. Each key can have d
1010
## Key Modes
1111

1212
- **read**: Can only read data, no modifications allowed
13-
- **write**: Can read and modify data, but cannot upload new bundles
1413
- **upload**: Can read, modify, and upload new bundles
14+
- **write**: Can read, modify data, and upload bundles
1515
- **all**: Full access to all operations
1616

17+
Key modes follow a stepped/gradual schema. If you have a upload key, and then you create an write key, the write key will be able to do everything that the upload key could.
18+
Please take a look at the following diagram to better understand how API key work.
19+
20+
<div class="mx-auto">
21+
<img src="/capgo_apikeys_diagram.webp" alt="A diagram explaining how API key work"
22+
</div>
23+
1724
## Security Best Practices
1825

1926
1. **Principle of Least Privilege**: Always use the most restrictive mode that still allows your integration to function

0 commit comments

Comments
 (0)