andwati/zitadel
1
0
Fork 0
mirror of https://github.com/andwati/zitadel.git synced 2026-10-18 05:52:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update naming on authorizations requests to role assignments (#11850)

Browse Source 
# Which Problems Are Solved

API Requests in the docs, still had old naming

# How the Problems Are Solved

Updated Authorization Reuqest naming in docs with role assignments
This commit is contained in:
Fabienne Bühler
2026-03-19 09:45:21 +01:00
committed by GitHub
parent ca4bba3992
commit a592fd7293
2 changed files with 19 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
proto/zitadel/authorization/v2/authorization_service.proto
+18 -18
View File
@@ -14,20 +14,20 @@ import "zitadel/filter/v2/filter.proto";
option go_package = "github.com/zitadel/zitadel/pkg/grpc/authorization/v2;authorization";
// AuthorizationService provides methods to manage authorizations for users within your projects and applications.
//
// Note: We have streamlined our naming conventions to improve clarity. Authorization in this context refers to role assignments, not to OAuth authorization.
//
// AuthorizationService provides methods to manage authorizations for users within your projects and applications.
//
// For managing permissions and roles for Zitadel internal resources, like organizations, projects,
// users, etc., please use the InternalPermissionService.
service AuthorizationService {
// List Authorizations
//
// ListAuthorizations returns all authorizations matching the request and necessary permissions.
// List Role Assignment
//
// Note: Authorization in this context refers to role assignments, not to OAuth authorization.
//
// ListAuthorizations returns all authorizations matching the request and necessary permissions.
//
// Required permissions:
// - "user.grant.read"
// - no permissions required for listing own authorizations
@@ -39,12 +39,12 @@ service AuthorizationService {
};
}
// Create Authorization
//
// CreateAuthorization creates a new authorization for a user in an owned or granted project.
// Create Role Assignment
//
// Note: Authorization in this context refers to role assignments, not to OAuth authorization.
//
// CreateAuthorization creates a new authorization for a user in an owned or granted project.
//
// Required permissions:
// - "user.grant.write"
rpc CreateAuthorization(CreateAuthorizationRequest) returns (CreateAuthorizationResponse) {
@@ -55,12 +55,12 @@ service AuthorizationService {
};
}
// Update Authorization
//
// UpdateAuthorization updates the authorization.
// Update Role Assignments
//
// Note: Authorization in this context refers to role assignments, not to OAuth authorization.
//
// UpdateAuthorization updates the authorization.
//
// Note that any role keys previously granted to the user and not present in the request will be revoked.
//
// Required permissions:
@@ -73,12 +73,12 @@ service AuthorizationService {
};
}
// Delete Authorization
//
// DeleteAuthorization deletes the authorization.
// Delete Role Assignment
//
// Note: Authorization in this context refers to role assignments, not to OAuth authorization.
//
// DeleteAuthorization deletes the authorization.
//
// In case the authorization is not found, the request will return a successful response as
// the desired state is already achieved.
// You can check the deletion date in the response to verify if the authorization was deleted by the request.
@@ -93,12 +93,12 @@ service AuthorizationService {
};
}
// Activate Authorization
//
// ActivateAuthorization activates an existing but inactive authorization.
// Activate Role Assignment
//
// Note: Authorization in this context refers to role assignments, not to OAuth authorization.
//
// ActivateAuthorization activates an existing but inactive authorization.
//
// In case the authorization is already active, the request will return a successful response as
// the desired state is already achieved.
// You can check the change date in the response to verify if the authorization was activated by the request.
@@ -113,7 +113,7 @@ service AuthorizationService {
};
}
// Deactivate Authorization
// Deactivate Role Assignment
//
// DeactivateAuthorization deactivates an existing and active authorization.
//