Skip to content

API keys: update the endpoints to specify the key permission - #260

Merged
jenip13 merged 1 commit into
mainfrom
aparent/update_permission_for_endpoints
Sep 29, 2026
Merged

jenip13 merged 1 commit into
mainfrom
aparent/update_permission_for_endpoints

Conversation

@aaparent

Copy link
Copy Markdown
Member

Updated ~80 endpoints, adds which permission is needed to reach the endpoint via API key. I checked every endpoint manually.

Let me know if it doesn't look good. I tried using <Note>, <Callout>, and <Alert>, but I went with a key Icon and some text.

Screenshot 2026-09-25 at 9 20 13 PM Screenshot 2026-09-25 at 9 20 31 PM Screenshot 2026-09-25 at 9 20 36 PM Screenshot 2026-09-25 at 9 20 42 PM

Update ~80 endpoints, adds which permission is needed to reach the endpoint via API key.
I checked every endpoint manually.

Let me know if it doesn't look good. I tried using `<Note>`, `<Callout>`, and `<Alert>`, but I went with a key Icon and some text.
@mintlify

mintlify Bot commented Sep 26, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
flare 🟢 Ready View Preview Sep 26, 2026, 1:27 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

--- No newline at end of file
---

import PermissionReadOrganization from '/snippets/permission-read-organization.mdx'

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would expect a PUT to require WRITE, but a READ is required instead to allow regular users to edit their profile settings

@jenip13

jenip13 commented Sep 29, 2026 •

Copy link
Copy Markdown
Contributor

The following endpoints have different permissions for demo tenants:

Endpoint Label Needed on a demo tenant
GET /v2/me/feed/credentials Read Organization Read Tenant
GET /v2/tenants/{tenant_id} Read Organization Read Tenant
PUT /v2/tenants/{tenant_id} Write Organization Write Tenant
POST /v2/tenants/{tenant_id}/archive Write Organization Admin and Read Organization Write Tenant

As discussed with @xvaier , this can be ignored for the time being

@jenip13
jenip13 merged commit a87959a into main Sep 29, 2026
7 checks passed
@jenip13
jenip13 deleted the aparent/update_permission_for_endpoints branch September 29, 2026 18:22

This branch was successfully deployed

1 active deployment
staging - docs — edafb3dc Deployed Sep 26, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants