From 66b15c19ce64ac83b8db3c3931be86ffe64dd963 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matej=20Ba=C4=8Do?= Date: Fri, 11 Sep 2026 11:32:45 +0200 Subject: [PATCH] feat(organization): add detailed scopes for project key management Organization key routes now accept organization.projects.keys.read and organization.projects.keys.write alongside the legacy keys.read and keys.write scopes. The new scopes are listed for organization API keys and granted to console admin roles. Co-Authored-By: Claude Fable 5.1 --- app/config/roles.php | 2 ++ app/config/scopes/organization.php | 9 +++++++++ .../Modules/Organization/Http/Projects/Keys/Create.php | 2 +- .../Modules/Organization/Http/Projects/Keys/Delete.php | 2 +- .../Organization/Http/Projects/Keys/Ephemeral/Create.php | 2 +- .../Modules/Organization/Http/Projects/Keys/Get.php | 2 +- .../Modules/Organization/Http/Projects/Keys/Update.php | 2 +- .../Modules/Organization/Http/Projects/Keys/XList.php | 2 +- tests/e2e/Services/Console/ConsoleConsoleClientTest.php | 2 ++ tests/e2e/Services/Console/ConsoleCustomServerTest.php | 2 ++ 10 files changed, 21 insertions(+), 6 deletions(-) diff --git a/app/config/roles.php b/app/config/roles.php index fe952b59bd..d3394b05cf 100644 --- a/app/config/roles.php +++ b/app/config/roles.php @@ -92,6 +92,8 @@ $admins = [ 'projects.write', 'keys.read', 'keys.write', + 'organization.projects.keys.read', + 'organization.projects.keys.write', 'devKeys.read', 'devKeys.write', 'webhooks.read', diff --git a/app/config/scopes/organization.php b/app/config/scopes/organization.php index d74452f259..0a85dee1b0 100644 --- a/app/config/scopes/organization.php +++ b/app/config/scopes/organization.php @@ -12,6 +12,15 @@ return [ "Access to create, update, and delete organization projects", "category" => "Projects", ], + "organization.projects.keys.read" => [ + "description" => 'Access to read organization projects\' API keys', + "category" => "Projects", + ], + "organization.projects.keys.write" => [ + "description" => + "Access to create, update, and delete organization projects' API keys", + "category" => "Projects", + ], "devKeys.read" => [ "description" => 'Access to read project\'s development keys', "category" => "Other", diff --git a/src/Appwrite/Platform/Modules/Organization/Http/Projects/Keys/Create.php b/src/Appwrite/Platform/Modules/Organization/Http/Projects/Keys/Create.php index 5e546a9e12..dbef9c87cc 100644 --- a/src/Appwrite/Platform/Modules/Organization/Http/Projects/Keys/Create.php +++ b/src/Appwrite/Platform/Modules/Organization/Http/Projects/Keys/Create.php @@ -42,7 +42,7 @@ class Create extends Action ->setHttpPath('/v1/organization/projects/:projectId/keys') ->desc('Create project key') ->groups(['api', 'organization']) - ->label('scope', 'keys.write') + ->label('scope', ['organization.projects.keys.write', 'keys.write']) ->label('event', 'keys.[keyId].create') ->label('audits.event', 'project.key.create') ->label('audits.resource', 'project.key/{response.$id}') diff --git a/src/Appwrite/Platform/Modules/Organization/Http/Projects/Keys/Delete.php b/src/Appwrite/Platform/Modules/Organization/Http/Projects/Keys/Delete.php index 8c73554d0d..122e09b7f7 100644 --- a/src/Appwrite/Platform/Modules/Organization/Http/Projects/Keys/Delete.php +++ b/src/Appwrite/Platform/Modules/Organization/Http/Projects/Keys/Delete.php @@ -33,7 +33,7 @@ class Delete extends Action ->setHttpPath('/v1/organization/projects/:projectId/keys/:keyId') ->desc('Delete project key') ->groups(['api', 'organization']) - ->label('scope', 'keys.write') + ->label('scope', ['organization.projects.keys.write', 'keys.write']) ->label('event', 'keys.[keyId].delete') ->label('audits.event', 'project.key.delete') ->label('audits.resource', 'project.key/{request.keyId}') diff --git a/src/Appwrite/Platform/Modules/Organization/Http/Projects/Keys/Ephemeral/Create.php b/src/Appwrite/Platform/Modules/Organization/Http/Projects/Keys/Ephemeral/Create.php index b2b3e53e70..c88ac87aa3 100644 --- a/src/Appwrite/Platform/Modules/Organization/Http/Projects/Keys/Ephemeral/Create.php +++ b/src/Appwrite/Platform/Modules/Organization/Http/Projects/Keys/Ephemeral/Create.php @@ -40,7 +40,7 @@ class Create extends Action ->setHttpPath('/v1/organization/projects/:projectId/keys/ephemeral') ->desc('Create ephemeral project key') ->groups(['api', 'organization']) - ->label('scope', 'keys.write') + ->label('scope', ['organization.projects.keys.write', 'keys.write']) ->label('event', 'keys.[keyId].create') ->label('audits.event', 'project.key.create') ->label('audits.resource', 'project.key/{response.$id}') diff --git a/src/Appwrite/Platform/Modules/Organization/Http/Projects/Keys/Get.php b/src/Appwrite/Platform/Modules/Organization/Http/Projects/Keys/Get.php index 70caad8587..015bd72687 100644 --- a/src/Appwrite/Platform/Modules/Organization/Http/Projects/Keys/Get.php +++ b/src/Appwrite/Platform/Modules/Organization/Http/Projects/Keys/Get.php @@ -30,7 +30,7 @@ class Get extends Action ->setHttpPath('/v1/organization/projects/:projectId/keys/:keyId') ->desc('Get project key') ->groups(['api', 'organization']) - ->label('scope', 'keys.read') + ->label('scope', ['organization.projects.keys.read', 'keys.read']) ->label('sdk', new Method( namespace: 'organization', group: 'keys', diff --git a/src/Appwrite/Platform/Modules/Organization/Http/Projects/Keys/Update.php b/src/Appwrite/Platform/Modules/Organization/Http/Projects/Keys/Update.php index 4fb8e1e830..00b9abb46f 100644 --- a/src/Appwrite/Platform/Modules/Organization/Http/Projects/Keys/Update.php +++ b/src/Appwrite/Platform/Modules/Organization/Http/Projects/Keys/Update.php @@ -40,7 +40,7 @@ class Update extends Action ->setHttpPath('/v1/organization/projects/:projectId/keys/:keyId') ->desc('Update project key') ->groups(['api', 'organization']) - ->label('scope', 'keys.write') + ->label('scope', ['organization.projects.keys.write', 'keys.write']) ->label('event', 'keys.[keyId].update') ->label('audits.event', 'project.key.update') ->label('audits.resource', 'project.key/{response.$id}') diff --git a/src/Appwrite/Platform/Modules/Organization/Http/Projects/Keys/XList.php b/src/Appwrite/Platform/Modules/Organization/Http/Projects/Keys/XList.php index 2ec6b484a3..71e3a213dd 100644 --- a/src/Appwrite/Platform/Modules/Organization/Http/Projects/Keys/XList.php +++ b/src/Appwrite/Platform/Modules/Organization/Http/Projects/Keys/XList.php @@ -36,7 +36,7 @@ class XList extends Action ->setHttpPath('/v1/organization/projects/:projectId/keys') ->desc('List project keys') ->groups(['api', 'organization']) - ->label('scope', 'keys.read') + ->label('scope', ['organization.projects.keys.read', 'keys.read']) ->label('sdk', new Method( namespace: 'organization', group: 'keys', diff --git a/tests/e2e/Services/Console/ConsoleConsoleClientTest.php b/tests/e2e/Services/Console/ConsoleConsoleClientTest.php index 802cb4bea7..597256be7c 100644 --- a/tests/e2e/Services/Console/ConsoleConsoleClientTest.php +++ b/tests/e2e/Services/Console/ConsoleConsoleClientTest.php @@ -196,6 +196,8 @@ final class ConsoleConsoleClientTest extends Scope // Well-known scopes must be present $this->assertContains('projects.read', $scopeIds); $this->assertContains('projects.write', $scopeIds); + $this->assertContains('organization.projects.keys.read', $scopeIds); + $this->assertContains('organization.projects.keys.write', $scopeIds); // Every scope has the expected shape foreach ($response['body']['scopes'] as $scope) { diff --git a/tests/e2e/Services/Console/ConsoleCustomServerTest.php b/tests/e2e/Services/Console/ConsoleCustomServerTest.php index b3adc2b940..98550ccc3a 100644 --- a/tests/e2e/Services/Console/ConsoleCustomServerTest.php +++ b/tests/e2e/Services/Console/ConsoleCustomServerTest.php @@ -93,6 +93,8 @@ final class ConsoleCustomServerTest extends Scope $scopeIds = \array_column($response['body']['scopes'], '$id'); $this->assertContains('projects.read', $scopeIds); + $this->assertContains('organization.projects.keys.read', $scopeIds); + $this->assertContains('organization.projects.keys.write', $scopeIds); $projectsRead = null; foreach ($response['body']['scopes'] as $scope) {