TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-08-14 00:57:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

moved to v2beta and updated descriptions

Browse Source
This commit is contained in:
Livio Spring
2025-02-13 09:13:46 +01:00
parent 1d2c6a0d29
commit 88728b00ae
4 changed files with 24 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
proto/zitadel/authorizations/v2/authorization.proto → proto/zitadel/authorizations/v2beta/authorization.proto
View File

@@ -1,12 +1,12 @@
syntax = "proto3"; syntax = "proto3";
package zitadel.authorizations.v2; package zitadel.authorizations.v2beta;
import "google/protobuf/timestamp.proto"; import "google/protobuf/timestamp.proto";
import "validate/validate.proto"; import "validate/validate.proto";
import "zitadel/object/v2/object.proto"; import "zitadel/object/v2/object.proto";
option go_package = "github.com/zitadel/zitadel/pkg/grpc/authorizations/v2;authorizations"; option go_package = "github.com/zitadel/zitadel/pkg/grpc/authorizations/v2beta;authorizations";
message Authorization { message Authorization {
// ID is the unique identifier of the authorization. // ID is the unique identifier of the authorization.
@@ -33,7 +33,11 @@ message Authorization {
enum State { enum State {
STATE_UNSPECIFIED = 0; STATE_UNSPECIFIED = 0;
// An active authorization grants the user access with the roles specified on the project.
STATE_ACTIVE = 1; STATE_ACTIVE = 1;
// An inactive authorization temporarily deactivates the granted access and roles.
// ZITADEL will not include the specific authorization in any authorization information like an access token.
// But the information can still be accessed using the API.
STATE_INACTIVE = 2; STATE_INACTIVE = 2;
} }
@@ -43,7 +47,6 @@ message User {
// PreferredLoginName represents the preferred login name of the granted user. // PreferredLoginName represents the preferred login name of the granted user.
string preferred_login_name = 2; string preferred_login_name = 2;
// DisplayName represents the public display name of the granted user. // DisplayName represents the public display name of the granted user.
// By default it's the user's given name and family name, their username or their email address.
string display_name = 3; string display_name = 3;
// AvatarURL is the URL to the user's public avatar image. // AvatarURL is the URL to the user's public avatar image.
string avatar_url = 4; string avatar_url = 4;
@@ -163,7 +166,7 @@ message StateQuery {
message UserIDQuery { message UserIDQuery {
// Specify the ID of the user who was granted the authorization to search for. // Specify the ID of the user who was granted the authorization to search for.
string user_id = 1 [(validate.rules).string = { string id = 1 [(validate.rules).string = {
min_len: 1 min_len: 1
max_len: 200 max_len: 200
}]; }];
@@ -172,7 +175,7 @@ message UserIDQuery {
message UserOrganizationIDQuery { message UserOrganizationIDQuery {
// Specify the ID of the organization the user is part of to search for. // Specify the ID of the organization the user is part of to search for.
// Note that this might not be the organization the authorization was granted for. // Note that this might not be the organization the authorization was granted for.
string user_organization_id = 1 [(validate.rules).string = { string id = 1 [(validate.rules).string = {
min_len: 1 min_len: 1
max_len: 200 max_len: 200
}]; }];
@@ -180,7 +183,7 @@ message UserOrganizationIDQuery {
message UserPreferredLoginNameQuery { message UserPreferredLoginNameQuery {
// Specify the preferred login name of the granted user to search for. // Specify the preferred login name of the granted user to search for.
string user_preferred_login_name = 1 [(validate.rules).string = { string login_name = 1 [(validate.rules).string = {
min_len: 1 min_len: 1
max_len: 200 max_len: 200
}]; }];
@@ -192,7 +195,7 @@ message UserPreferredLoginNameQuery {
message UserDisplayNameQuery { message UserDisplayNameQuery {
// Specify the public display name of the granted user to search for. // Specify the public display name of the granted user to search for.
string user_display_name = 1 [(validate.rules).string = { string display_name = 1 [(validate.rules).string = {
min_len: 1 min_len: 1
max_len: 200 max_len: 200
}]; }];
@@ -205,7 +208,7 @@ message UserDisplayNameQuery {
message ProjectIDQuery { message ProjectIDQuery {
// Specify the ID of the project the user was granted the authorization for to search for. // Specify the ID of the project the user was granted the authorization for to search for.
// Note that this will also include authorizations granted for project grants of the same project. // Note that this will also include authorizations granted for project grants of the same project.
string project_id = 1 [(validate.rules).string = { string id = 1 [(validate.rules).string = {
min_len: 1 min_len: 1
max_len: 200 max_len: 200
}]; }];
@@ -214,7 +217,7 @@ message ProjectIDQuery {
message ProjectNameQuery { message ProjectNameQuery {
// Specify the name of the project the user was granted the authorization for to search for. // Specify the name of the project the user was granted the authorization for to search for.
// Note that this will also include authorizations granted for project grants of the same project. // Note that this will also include authorizations granted for project grants of the same project.
string project_name = 1 [(validate.rules).string = {max_len: 200}]; string name = 1 [(validate.rules).string = {max_len: 200}];
// Specify the method to search for the project name. Default is EQUAL. // Specify the method to search for the project name. Default is EQUAL.
// For example, to search for all authorizations granted on a project with // For example, to search for all authorizations granted on a project with
// a name containing a specific string, use CONTAINS or CONTAINS_IGNORE_CASE. // a name containing a specific string, use CONTAINS or CONTAINS_IGNORE_CASE.
@@ -223,7 +226,7 @@ message ProjectNameQuery {
message ProjectGrantIDQuery { message ProjectGrantIDQuery {
// Specify the ID of the project grant the user was granted the authorization for to search for. // Specify the ID of the project grant the user was granted the authorization for to search for.
string project_grant_id = 1 [(validate.rules).string = { string id = 1 [(validate.rules).string = {
min_len: 1 min_len: 1
max_len: 200 max_len: 200
}]; }];
@@ -232,7 +235,7 @@ message ProjectGrantIDQuery {
message OrganizationIDQuery { message OrganizationIDQuery {
// Specify the ID of the organization the authorization was granted for to search for. // Specify the ID of the organization the authorization was granted for to search for.
// This can either be the organization the project or the project grant is part of. // This can either be the organization the project or the project grant is part of.
string organization_id = 1 [(validate.rules).string = { string id = 1 [(validate.rules).string = {
min_len: 1 min_len: 1
max_len: 200 max_len: 200
}]; }];
@@ -241,7 +244,7 @@ message OrganizationIDQuery {
message OrganizationNameQuery { message OrganizationNameQuery {
// Specify the name of the organization the authorization was granted for to search for. // Specify the name of the organization the authorization was granted for to search for.
// This can either be the organization the project or the project grant is part of. // This can either be the organization the project or the project grant is part of.
string organization_name = 1 [(validate.rules).string = {max_len: 200}]; string name = 1 [(validate.rules).string = {max_len: 200}];
// Specify the method to search for the organization name. Default is EQUAL. // Specify the method to search for the organization name. Default is EQUAL.
// For example, to search for all authorizations with an organization name containing a specific string, // For example, to search for all authorizations with an organization name containing a specific string,
// use CONTAINS or CONTAINS_IGNORE_CASE. // use CONTAINS or CONTAINS_IGNORE_CASE.
@@ -250,7 +253,7 @@ message OrganizationNameQuery {
message RoleKeyQuery { message RoleKeyQuery {
// Specify the key of the role the user was granted to search for. // Specify the key of the role the user was granted to search for.
string role_key = 1 [(validate.rules).string = {max_len: 200}]; string key = 1 [(validate.rules).string = {max_len: 200}];
// Specify the method to search for the role key. Default is EQUAL. // Specify the method to search for the role key. Default is EQUAL.
// For example, to search for all authorizations starting with a specific role key, // For example, to search for all authorizations starting with a specific role key,
// use STARTS_WITH or STARTS_WITH_IGNORE_CASE. // use STARTS_WITH or STARTS_WITH_IGNORE_CASE.

6
proto/zitadel/authorizations/v2/authorization_service.proto → proto/zitadel/authorizations/v2beta/authorization_service.proto
View File

@@ -1,13 +1,13 @@
syntax = "proto3"; syntax = "proto3";
package zitadel.authorizations.v2; package zitadel.authorizations.v2beta;
import "google/protobuf/timestamp.proto"; import "google/protobuf/timestamp.proto";
import "validate/validate.proto"; import "validate/validate.proto";
import "zitadel/authorizations/v2/authorization.proto"; import "zitadel/authorizations/v2beta/authorization.proto";
import "zitadel/object/v2/object.proto"; import "zitadel/object/v2/object.proto";
option go_package = "github.com/zitadel/zitadel/pkg/grpc/authorizations/v2;authorizations"; option go_package = "github.com/zitadel/zitadel/pkg/grpc/authorizations/v2beta;authorizations";
// AuthorizationService provides methods to manage authorizations for users within your projects and applications. // AuthorizationService provides methods to manage authorizations for users within your projects and applications.
// //

4
proto/zitadel/permissions/v2/manager.proto → proto/zitadel/permissions/v2beta/manager.proto
View File

@@ -4,9 +4,9 @@ import "google/protobuf/timestamp.proto";
import "validate/validate.proto"; import "validate/validate.proto";
import "zitadel/object/v2/object.proto"; import "zitadel/object/v2/object.proto";
package zitadel.permissions.v2; package zitadel.permissions.v2beta;
option go_package = "github.com/zitadel/zitadel/pkg/grpc/permissions/v2;permissions"; option go_package = "github.com/zitadel/zitadel/pkg/grpc/permissions/v2beta;permissions";
message Manager { message Manager {
// ID is the unique identifier of the manager role. // ID is the unique identifier of the manager role.

6
proto/zitadel/permissions/v2/permission_service.proto → proto/zitadel/permissions/v2beta/permission_service.proto
View File

@@ -1,13 +1,13 @@
syntax = "proto3"; syntax = "proto3";
package zitadel.permissions.v2; package zitadel.permissions.v2beta;
import "google/protobuf/timestamp.proto"; import "google/protobuf/timestamp.proto";
import "validate/validate.proto"; import "validate/validate.proto";
import "zitadel/object/v2/object.proto"; import "zitadel/object/v2/object.proto";
import "zitadel/permissions/v2/manager.proto"; import "zitadel/permissions/v2beta/manager.proto";
option go_package = "github.com/zitadel/zitadel/pkg/grpc/permissions/v2;permissions"; option go_package = "github.com/zitadel/zitadel/pkg/grpc/permissions/v2beta;permissions";
// PermissionsService provides methods to manage permissions for resource // PermissionsService provides methods to manage permissions for resource
// and their management in ZITADEL itself. // and their management in ZITADEL itself.