Grant a team access to a folder
/folders/{id}/team-permissionsGives a team read or write on the folder and returns every member. read sees the folder and its documents, write also changes them. It grants exactly that level and removes the team from the other one, and reaches subfolders and documents through inheritance. Needs write access to the folder, else 403 forbidden (see that response). Emits folder.updated after commit; no email. DELETE /folders/{id}/team-permissions/{member_id} undoes it.
Path parameters
The record's id.
Query parameters
Validate and run the call without committing it, returning what the real call would return with
meta.dry_runset.
Headers
Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.
Request body
application/json, required · FolderTeamPermission
The team's id.
- One of:
What the team may do: read sees the folder and its documents, write also changes them.
read,write
{
"id": "9d8c7b6a-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
"level": "read"
}Responses
{
"data": [
{
"id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
"level": "read"
}
]
}Authorization failed. error.code is forbidden when the token's user can't write the folder: any folder in the tree of a deal the token can see is writable, otherwise the folder's write list, write flags or super admin are needed. This is deliberately broader than the platform (no editor-role check) and stricter (the check applies where the platform skips it by role). Other codes are missing_scope, scope_disabled, org_disabled, ip_blocked, user_disabled.
The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per
problem, or a code documented on the operation.
Examples
curl -X POST https://your-org-domain/kong/core/api/v2/folders/{id}/team-permissions\
-H "Authorization: Bearer $HELM_API_KEY"\
-H "Content-Type: application/json"\
-d '{
"id": "9d8c7b6a-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
"level": "read"
}'