From 11e83b1ff154816188e0bfd66ffd29bfab61779c Mon Sep 17 00:00:00 2001 From: Nataly Merezhuk Date: Thu, 31 Oct 2024 10:18:09 -0400 Subject: [PATCH 1/2] Adds note on API permission scope. --- docs/en/cloud/manage/openapi.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/en/cloud/manage/openapi.md b/docs/en/cloud/manage/openapi.md index 890d2a2e607..827c41ced64 100644 --- 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](https://clickhouse.com/docs/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) From 0352f795eaf39edb67dfe775342db3a787125d9e Mon Sep 17 00:00:00 2001 From: Justin de Guzman Date: Mon, 4 Nov 2024 11:50:39 -0800 Subject: [PATCH 2/2] Edit link --- docs/en/cloud/manage/openapi.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/cloud/manage/openapi.md b/docs/en/cloud/manage/openapi.md index 827c41ced64..7d09d7cc167 100644 --- a/docs/en/cloud/manage/openapi.md +++ b/docs/en/cloud/manage/openapi.md @@ -22,7 +22,7 @@ This document covers the ClickHouse Cloud API. For database API endpoints, pleas 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](https://clickhouse.com/docs/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. +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)