fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! Merge branch 'main' into org_api

This commit is contained in:
Iraq Jaber
2025-05-19 17:22:50 +02:00
parent 07ffc92481
commit fe74d6b88d
5 changed files with 204 additions and 144 deletions

View File

@@ -45,7 +45,7 @@ enum OrgFieldName {
ORG_FIELD_NAME_CREATION_DATE = 2;
}
message OrgQueryFilter {
message OrganizationSearchFilter{
oneof query {
option (validate.required) = true;

View File

@@ -19,93 +19,93 @@ import "zitadel/filter/v2beta/filter.proto";
option go_package = "github.com/zitadel/zitadel/pkg/grpc/org/v2beta;org";
// option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
// info: {
// title: "Organization Service (Beta)";
// version: "2.0-beta";
// description: "This API is intended to manage organizations in a ZITADEL instance. This project is in beta state. It can AND will continue breaking until the services provide the same functionality as the current login.";
// contact:{
// name: "ZITADEL"
// url: "https://zitadel.com"
// email: "hi@zitadel.com"
// }
// license: {
// name: "Apache 2.0",
// url: "https://github.com/zitadel/zitadel/blob/main/LICENSING.md";
// };
// };
// schemes: HTTPS;
// schemes: HTTP;
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
info: {
title: "Organization Service (Beta)";
version: "2.0-beta";
description: "This API is intended to manage organizations in a ZITADEL instance. This project is in beta state. It can AND will continue breaking until the services provide the same functionality as the current login.";
contact:{
name: "ZITADEL"
url: "https://zitadel.com"
email: "hi@zitadel.com"
}
license: {
name: "Apache 2.0",
url: "https://github.com/zitadel/zitadel/blob/main/LICENSING.md";
};
};
schemes: HTTPS;
schemes: HTTP;
// consumes: "application/json";
// consumes: "application/grpc";
consumes: "application/json";
consumes: "application/grpc";
// produces: "application/json";
// produces: "application/grpc";
produces: "application/json";
produces: "application/grpc";
// consumes: "application/grpc-web+proto";
// produces: "application/grpc-web+proto";
consumes: "application/grpc-web+proto";
produces: "application/grpc-web+proto";
// host: "$CUSTOM-DOMAIN";
// base_path: "/";
host: "$CUSTOM-DOMAIN";
base_path: "/";
// external_docs: {
// description: "Detailed information about ZITADEL",
// url: "https://zitadel.com/docs"
// }
// security_definitions: {
// security: {
// key: "OAuth2";
// value: {
// type: TYPE_OAUTH2;
// flow: FLOW_ACCESS_CODE;
// authorization_url: "$CUSTOM-DOMAIN/oauth/v2/authorize";
// token_url: "$CUSTOM-DOMAIN/oauth/v2/token";
// scopes: {
// scope: {
// key: "openid";
// value: "openid";
// }
// scope: {
// key: "urn:zitadel:iam:org:project:id:zitadel:aud";
// value: "urn:zitadel:iam:org:project:id:zitadel:aud";
// }
// }
// }
// }
// }
// security: {
// security_requirement: {
// key: "OAuth2";
// value: {
// scope: "openid";
// scope: "urn:zitadel:iam:org:project:id:zitadel:aud";
// }
// }
// }
// responses: {
// key: "403";
// value: {
// description: "Returned when the user does not have permission to access the resource.";
// schema: {
// json_schema: {
// ref: "#/definitions/rpcStatus";
// }
// }
// }
// }
// responses: {
// key: "404";
// value: {
// description: "Returned when the resource does not exist.";
// schema: {
// json_schema: {
// ref: "#/definitions/rpcStatus";
// }
// }
// }
// }
// };
external_docs: {
description: "Detailed information about ZITADEL",
url: "https://zitadel.com/docs"
}
security_definitions: {
security: {
key: "OAuth2";
value: {
type: TYPE_OAUTH2;
flow: FLOW_ACCESS_CODE;
authorization_url: "$CUSTOM-DOMAIN/oauth/v2/authorize";
token_url: "$CUSTOM-DOMAIN/oauth/v2/token";
scopes: {
scope: {
key: "openid";
value: "openid";
}
scope: {
key: "urn:zitadel:iam:org:project:id:zitadel:aud";
value: "urn:zitadel:iam:org:project:id:zitadel:aud";
}
}
}
}
}
security: {
security_requirement: {
key: "OAuth2";
value: {
scope: "openid";
scope: "urn:zitadel:iam:org:project:id:zitadel:aud";
}
}
}
responses: {
key: "403";
value: {
description: "Returned when the user does not have permission to access the resource.";
schema: {
json_schema: {
ref: "#/definitions/rpcStatus";
}
}
}
}
responses: {
key: "404";
value: {
description: "Returned when the resource does not exist.";
schema: {
json_schema: {
ref: "#/definitions/rpcStatus";
}
}
}
}
};
service OrganizationService {
@@ -371,7 +371,7 @@ service OrganizationService {
// - `org.write`
rpc DeactivateOrganization(DeactivateOrganizationRequest) returns (DeactivateOrganizationResponse) {
option (google.api.http) = {
post: "/v2beta/organizations/_deactivate"
post: "/v2beta/organizations/deactivate"
body: "*"
};
@@ -438,7 +438,7 @@ message CreatedAdmin {
message CreateOrganizationResponse{
// The timestamp of the organization was created.
google.protobuf.Timestamp created_date = 1 [
google.protobuf.Timestamp creation_date = 1 [
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
example: "\"2024-12-18T07:50:47.492Z\"";
}
@@ -499,7 +499,7 @@ message ListOrganizationsRequest {
zitadel.org.v2beta.OrgFieldName sorting_column = 2;
// Define the criteria to query for.
// repeated ProjectRoleFilter filters = 4;
repeated zitadel.org.v2beta.OrgQueryFilter OrganizationSearchFilter = 3;
repeated zitadel.org.v2beta.OrganizationSearchFilter filter = 3;
}
message ListOrganizationsResponse {
@@ -529,7 +529,7 @@ message DeleteOrganizationRequest {
message DeleteOrganizationResponse {
// The timestamp of the deletion of the organization.
google.protobuf.Timestamp change_date = 1 [
google.protobuf.Timestamp deletion_date = 1 [
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
example: "\"2025-01-23T10:34:18.051Z\"";
}
@@ -604,7 +604,7 @@ message AddOrganizationDomainRequest {
message AddOrganizationDomainResponse {
// The timestamp of the organization was created.
google.protobuf.Timestamp created_date = 1 [
google.protobuf.Timestamp creation_date = 1 [
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
example: "\"2024-12-18T07:50:47.492Z\"";
}
@@ -670,7 +670,8 @@ message DeleteOrganizationDomainResponse {
message GenerateOrganizationDomainValidationRequest {
// Organization Id for the Organization which doman to be validated.
string id = 1 [
string organization_id = 1 [
(validate.rules).string = {min_len: 1, max_len: 200},
(google.api.field_behavior) = REQUIRED,
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
@@ -709,7 +710,7 @@ message GenerateOrganizationDomainValidationResponse {
message VerifyOrganizationDomainRequest {
// Organization Id for the Organization doman to be verified.
string id = 1 [
string organization_id = 1 [
(validate.rules).string = {min_len: 1, max_len: 200},
(google.api.field_behavior) = REQUIRED,
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
@@ -767,7 +768,7 @@ message SetOrganizationMetadataResponse{
message ListOrganizationMetadataRequest {
// Organization ID of Orgalization which metadata is to be listed.
string id = 1 [
string organization_id = 1 [
(validate.rules).string = {min_len: 1, max_len: 200},
(google.api.field_behavior) = REQUIRED,
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
@@ -792,7 +793,7 @@ message ListOrganizationMetadataResponse {
message DeleteOrganizationMetadataRequest {
// Organization ID of Orgalization which metadata is to be deleted is stored on.
string id = 1;
string organization_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}];
}