diff --git a/proto/zitadel/org/v2beta/org_service.proto b/proto/zitadel/org/v2beta/org_service.proto index 3cc9661585..c43c56b777 100644 --- a/proto/zitadel/org/v2beta/org_service.proto +++ b/proto/zitadel/org/v2beta/org_service.proto @@ -406,15 +406,17 @@ service OrganizationService { } message CreateOrganizationRequest{ + // The Admin for the newly created Organization. message Admin { oneof user_type{ string user_id = 1; zitadel.user.v2beta.AddHumanUserRequest human = 2; } - // specify Org Member Roles for the provided user (default is ORG_OWNER if roles are empty) + // specify Organization Member Roles for the provided user (default is ORG_OWNER if roles are empty) repeated string roles = 3; } + // name of the Organization to be created. string name = 1 [ (validate.rules).string = {min_len: 1, max_len: 200}, (google.api.field_behavior) = REQUIRED, @@ -424,21 +426,24 @@ message CreateOrganizationRequest{ example: "\"ZITADEL\""; } ]; + // Additional Admins for the Organization. repeated Admin admins = 2; } +message CreatedAdmin { + string user_id = 1; + optional string email_code = 2; + optional string phone_code = 3; +} + message CreateOrganizationResponse{ - message CreatedAdmin { - string user_id = 1; - optional string email_code = 2; - optional string phone_code = 3; - } // The timestamp of the organization was created. google.protobuf.Timestamp created_date = 1 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { example: "\"2024-12-18T07:50:47.492Z\""; } ]; + // Organization ID of the newly created organization. string id = 2 [ (validate.rules).string = {min_len: 1, max_len: 200}, @@ -449,10 +454,13 @@ message CreateOrganizationResponse{ example: "\"69629012906488334\""; } ]; + + // The admins created for the Organization repeated CreatedAdmin created_admins = 3; } message UpdateOrganizationRequest { + // Organization Id for the Organization to be updated string id = 1 [ (validate.rules).string = {min_len: 1, max_len: 200}, (google.api.field_behavior) = REQUIRED, @@ -464,6 +472,7 @@ message UpdateOrganizationRequest { } ]; + // New Name for the Organization to be updated string name = 2 [ (validate.rules).string = {min_len: 1, max_len: 200}, (google.api.field_behavior) = REQUIRED, @@ -502,7 +511,9 @@ message ListOrganizationsRequest { } message ListOrganizationsResponse { + // Pagination of the Organizations results zitadel.filter.v2beta.PaginationResponse pagination = 1; + // The Organizations requested repeated zitadel.org.v2beta.Organization result = 2; } @@ -513,6 +524,7 @@ message DeleteOrganizationRequest { }; }; + // Organization Id for the Organization to be deleted string id = 1 [ (validate.rules).string = {min_len: 1, max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { @@ -533,6 +545,7 @@ message DeleteOrganizationResponse { } message DeactivateOrganizationRequest { + // Organization Id for the Organization to be deactivated string id = 1 [ (validate.rules).string = {min_len: 1, max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { @@ -553,6 +566,7 @@ message DeactivateOrganizationResponse { } message ReactivateOrganizationRequest { + // Organization Id for the Organization to be reactivated string id = 1 [ (validate.rules).string = {min_len: 1, max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { @@ -573,6 +587,7 @@ message ReactivateOrganizationResponse { } message AddOrganizationDomainRequest { + // Organization Id for the Organization for which the domain is to be added to. string id = 1 [ (validate.rules).string = {min_len: 1, max_len: 200}, (google.api.field_behavior) = REQUIRED, @@ -583,6 +598,7 @@ message AddOrganizationDomainRequest { description: "Organization ID of the organization you want to add a domain to." } ]; + // The domain you want to add to the organization. string domain = 2 [ (validate.rules).string = {min_len: 1, max_len: 200}, (google.api.field_behavior) = REQUIRED, @@ -604,6 +620,7 @@ message AddOrganizationDomainResponse { } message ListOrganizationDomainsRequest { + // Organization Id for the Organization which domains are to be listed. string id = 1 [ (validate.rules).string = {min_len: 1, max_len: 200}, (google.api.field_behavior) = REQUIRED, @@ -622,11 +639,13 @@ message ListOrganizationDomainsRequest { } message ListOrganizationDomainsResponse { + // Pagination of the Organizations domain results. zitadel.filter.v2beta.PaginationResponse pagination = 1; repeated Domain result = 2; } message DeleteOrganizationDomainRequest { + // Organization Id for the Organization which domain is to be deleted. string id = 1 [ (validate.rules).string = {min_len: 1, max_len: 200}, (google.api.field_behavior) = REQUIRED, @@ -659,6 +678,7 @@ message DeleteOrganizationDomainResponse { } message GenerateOrganizationDomainValidationRequest { + // Organization Id for the Organization which doman to be validated. string id = 1 [ (validate.rules).string = {min_len: 1, max_len: 200}, (google.api.field_behavior) = REQUIRED, @@ -669,6 +689,7 @@ message GenerateOrganizationDomainValidationRequest { description: "Organization ID of the organization you want to generate a validation request for." } ]; + // The domain which to be deleted. string domain = 2 [ (validate.rules).string = {min_len: 1, max_len: 200}, (google.api.field_behavior) = REQUIRED, @@ -695,6 +716,7 @@ message GenerateOrganizationDomainValidationResponse { } message VerifyOrganizationDomainRequest { + // Organization Id for the Organization doman to be verified. string id = 1 [ (validate.rules).string = {min_len: 1, max_len: 200}, (google.api.field_behavior) = REQUIRED, @@ -705,6 +727,7 @@ message VerifyOrganizationDomainRequest { description: "Organization ID of the organization you want to veryify the domain on." } ]; + // Organization Id for the Organization doman to be verified. string domain = 2 [ (validate.rules).string = {min_len: 1, max_len: 200}, (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { @@ -749,7 +772,7 @@ message SetOrganizationMetadataResponse{ } message ListOrganizationMetadataRequest { - // Organization ID + // Organization ID of Orgalization which metadata is to be listed. string id = 1 [ (validate.rules).string = {min_len: 1, max_len: 200}, (google.api.field_behavior) = REQUIRED, @@ -767,12 +790,16 @@ message ListOrganizationMetadataRequest { } message ListOrganizationMetadataResponse { + // Pagination of the Organizations metadata results. zitadel.filter.v2beta.PaginationResponse pagination = 1; + // THe Organization metadata requested. repeated zitadel.metadata.v2beta.Metadata result = 2; } message DeleteOrganizationMetadataRequest { + // Organization ID of Orgalization which metadata is to be deleted is stored on. string id = 1; + // The key for the Organization metadata to be deleted. repeated string keys = 2 [(validate.rules).repeated.items.string = {min_len: 1, max_len: 200}]; }