Merge pull request #2743 from ClickHouse/nataly/api-role-note

Add note on API permission scope.
ClickHouse · Nov 4, 2024 · 1758dff · 1758dff
2 parents 74cfb63 + 0352f79
commit 1758dff
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/docs/en/cloud/manage/openapi.md b/docs/en/cloud/manage/openapi.md
@@ -21,6 +21,9 @@ This document covers the ClickHouse Cloud API. For database API endpoints, pleas
   ![Initial API Screen](@site/docs/en/_snippets/images/openapi2.png) 
 
 3. To create an API key, specify the key name, permissions for the key, and expiration time, then click `Generate API Key`.
+:::note
+Permissions align with ClickHouse Cloud [predefined roles](/en/cloud/security/cloud-access-management#predefined-roles). The developer role has read-only permissions and the admin role has full read and write permissions.
+:::
 
   ![Create API Key](@site/docs/en/_snippets/images/openapi3.png)