mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-14 18:57:45 +00:00
fixup! Merge branch 'org_api_docs' into org_api
This commit is contained in:
@@ -356,6 +356,14 @@ module.exports = {
|
|||||||
categoryLinkSource: "auto",
|
categoryLinkSource: "auto",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
org_v2beta: {
|
||||||
|
specPath: ".artifacts/openapi/zitadel/org/v2beta/org_service.swagger.json",
|
||||||
|
outputDir: "docs/apis/resources/org_service_v2beta",
|
||||||
|
sidebarOptions: {
|
||||||
|
groupPathsBy: "tag",
|
||||||
|
categoryLinkSource: "auto",
|
||||||
|
},
|
||||||
|
},
|
||||||
idp_v2: {
|
idp_v2: {
|
||||||
specPath: ".artifacts/openapi/zitadel/idp/v2/idp_service.swagger.json",
|
specPath: ".artifacts/openapi/zitadel/idp/v2/idp_service.swagger.json",
|
||||||
outputDir: "docs/apis/resources/idp_service_v2",
|
outputDir: "docs/apis/resources/idp_service_v2",
|
||||||
|
@@ -1237,7 +1237,7 @@ service AdminService {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// Deprecated: use ListOrganization [/v2beta/organization/_search] API instead
|
// Deprecated: use ListOrganization [apis/resources/org_service_v2beta/organization-service-list-organizations.api.mdx] API instead
|
||||||
rpc ListOrgs(ListOrgsRequest) returns (ListOrgsResponse) {
|
rpc ListOrgs(ListOrgsRequest) returns (ListOrgsResponse) {
|
||||||
option (google.api.http) = {
|
option (google.api.http) = {
|
||||||
post: "/orgs/_search";
|
post: "/orgs/_search";
|
||||||
@@ -1273,7 +1273,7 @@ service AdminService {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// Deprecated: use CreateOrganization [/v2beta/organization] API instead
|
// Deprecated: use CreateOrganization [apis/resources/org_service_v2beta/organization-service-create-organization.api.mdx] API instead
|
||||||
rpc SetUpOrg(SetUpOrgRequest) returns (SetUpOrgResponse) {
|
rpc SetUpOrg(SetUpOrgRequest) returns (SetUpOrgResponse) {
|
||||||
option (google.api.http) = {
|
option (google.api.http) = {
|
||||||
post: "/orgs/_setup";
|
post: "/orgs/_setup";
|
||||||
@@ -1309,7 +1309,7 @@ service AdminService {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// Deprecated: use ListOrganization [/v2beta/organization] API instead
|
// Deprecated: use DeleteOrganization [apis/resources/org_service_v2beta/organization-service-delete-organization.api.mdx] API instead
|
||||||
rpc RemoveOrg(RemoveOrgRequest) returns (RemoveOrgResponse) {
|
rpc RemoveOrg(RemoveOrgRequest) returns (RemoveOrgResponse) {
|
||||||
option (google.api.http) = {
|
option (google.api.http) = {
|
||||||
delete: "/orgs/{org_id}"
|
delete: "/orgs/{org_id}"
|
||||||
|
@@ -2119,7 +2119,7 @@ service ManagementService {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// Deprecated: use CreateOrganization [/v2beta/organization] API instead
|
// Deprecated: use CreateOrganization [apis/resources/org_service_v2beta/organization-service-create-organization.api.mdx] API instead
|
||||||
rpc AddOrg(AddOrgRequest) returns (AddOrgResponse) {
|
rpc AddOrg(AddOrgRequest) returns (AddOrgResponse) {
|
||||||
option (google.api.http) = {
|
option (google.api.http) = {
|
||||||
post: "/orgs"
|
post: "/orgs"
|
||||||
@@ -2146,7 +2146,7 @@ service ManagementService {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// Deprecated: use UpdateOrganization [/v2beta/organization] API instead
|
// Deprecated: use UpdateOrganization [apis/resources/org_service_v2beta/organization-service-update-organization.api.mdx] API instead
|
||||||
rpc UpdateOrg(UpdateOrgRequest) returns (UpdateOrgResponse) {
|
rpc UpdateOrg(UpdateOrgRequest) returns (UpdateOrgResponse) {
|
||||||
option (google.api.http) = {
|
option (google.api.http) = {
|
||||||
put: "/orgs/me"
|
put: "/orgs/me"
|
||||||
@@ -2173,7 +2173,7 @@ service ManagementService {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// Deprecated: use DeactivateOrganization [/v2beta/organization/_deactivate] API instead
|
// Deprecated: use DeactivateOrganization [apis/resources/org_service_v2beta/organization-service-deactivate-organization.api.mdx] API instead
|
||||||
rpc DeactivateOrg(DeactivateOrgRequest) returns (DeactivateOrgResponse) {
|
rpc DeactivateOrg(DeactivateOrgRequest) returns (DeactivateOrgResponse) {
|
||||||
option (google.api.http) = {
|
option (google.api.http) = {
|
||||||
post: "/orgs/me/_deactivate"
|
post: "/orgs/me/_deactivate"
|
||||||
@@ -2200,7 +2200,7 @@ service ManagementService {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// Deprecated: use ReactivateOrganization [/v2beta/organization/_reactivate] API instead
|
// Deprecated: use ActivateOrganization [apis/resources/org_service_v2beta/organization-service-activate-organization.api.mdx] API instead
|
||||||
rpc ReactivateOrg(ReactivateOrgRequest) returns (ReactivateOrgResponse) {
|
rpc ReactivateOrg(ReactivateOrgRequest) returns (ReactivateOrgResponse) {
|
||||||
option (google.api.http) = {
|
option (google.api.http) = {
|
||||||
post: "/orgs/me/_reactivate"
|
post: "/orgs/me/_reactivate"
|
||||||
@@ -2227,7 +2227,7 @@ service ManagementService {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// Deprecated: use ListOrganization [/v2beta/organization] API instead
|
// Deprecated: use DeleteOrganization [apis/resources/org_service_v2beta/organization-service-delete-organization.api.mdx] API instead
|
||||||
rpc RemoveOrg(RemoveOrgRequest) returns (RemoveOrgResponse) {
|
rpc RemoveOrg(RemoveOrgRequest) returns (RemoveOrgResponse) {
|
||||||
option (google.api.http) = {
|
option (google.api.http) = {
|
||||||
delete: "/orgs/me"
|
delete: "/orgs/me"
|
||||||
@@ -2253,7 +2253,7 @@ service ManagementService {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// Deprecated: use SetOrganizationMetadata [/v2beta/organization/metadata] API instead
|
// Deprecated: use SetOrganizationMetadata [apis/resources/org_service_v2beta/organization-service-set-organization-metadata.api.mdx] API instead
|
||||||
rpc SetOrgMetadata(SetOrgMetadataRequest) returns (SetOrgMetadataResponse) {
|
rpc SetOrgMetadata(SetOrgMetadataRequest) returns (SetOrgMetadataResponse) {
|
||||||
option (google.api.http) = {
|
option (google.api.http) = {
|
||||||
post: "/metadata/{key}"
|
post: "/metadata/{key}"
|
||||||
@@ -2281,7 +2281,7 @@ service ManagementService {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// Deprecated: use SetOrganizationMetadata [/v2beta/organization/metadata] API instead
|
// Deprecated: use SetOrganizationMetadata [apis/resources/org_service_v2beta/organization-service-set-organization-metadata.api.mdx] API instead
|
||||||
rpc BulkSetOrgMetadata(BulkSetOrgMetadataRequest) returns (BulkSetOrgMetadataResponse) {
|
rpc BulkSetOrgMetadata(BulkSetOrgMetadataRequest) returns (BulkSetOrgMetadataResponse) {
|
||||||
option (google.api.http) = {
|
option (google.api.http) = {
|
||||||
post: "/metadata/_bulk"
|
post: "/metadata/_bulk"
|
||||||
@@ -2309,7 +2309,7 @@ service ManagementService {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// Deprecated: use ListOrganizationMetadata [/v2beta/organization/metadata/_search] API instead
|
// Deprecated: use ListOrganizationMetadata [apis/resources/org_service_v2beta/organization-service-list-organization-metadata.api.mdx] API instead
|
||||||
rpc ListOrgMetadata(ListOrgMetadataRequest) returns (ListOrgMetadataResponse) {
|
rpc ListOrgMetadata(ListOrgMetadataRequest) returns (ListOrgMetadataResponse) {
|
||||||
option (google.api.http) = {
|
option (google.api.http) = {
|
||||||
post: "/metadata/_search"
|
post: "/metadata/_search"
|
||||||
@@ -2337,7 +2337,7 @@ service ManagementService {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// Deprecated: use ListOrganizationMetadata [/v2beta/organization/metadata/_search] API instead
|
// Deprecated: use ListOrganizationMetadata [apis/resources/org_service_v2beta/organization-service-list-organization-metadata.api.mdx] API instead
|
||||||
rpc GetOrgMetadata(GetOrgMetadataRequest) returns (GetOrgMetadataResponse) {
|
rpc GetOrgMetadata(GetOrgMetadataRequest) returns (GetOrgMetadataResponse) {
|
||||||
option (google.api.http) = {
|
option (google.api.http) = {
|
||||||
get: "/metadata/{key}"
|
get: "/metadata/{key}"
|
||||||
@@ -2364,7 +2364,7 @@ service ManagementService {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// Deprecated: use DeleteOrganizationMetadata [/v2beta/organization/metadata] API instead
|
// Deprecated: use DeleteOrganizationMetadata [apis/resources/org_service_v2beta/organization-service-delete-organization-metadata.api.mdx] API instead
|
||||||
rpc RemoveOrgMetadata(RemoveOrgMetadataRequest) returns (RemoveOrgMetadataResponse) {
|
rpc RemoveOrgMetadata(RemoveOrgMetadataRequest) returns (RemoveOrgMetadataResponse) {
|
||||||
option (google.api.http) = {
|
option (google.api.http) = {
|
||||||
delete: "/metadata/{key}"
|
delete: "/metadata/{key}"
|
||||||
@@ -2391,6 +2391,7 @@ service ManagementService {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Deprecated: use DeleteOrganizationMetadata [apis/resources/org_service_v2beta/organization-service-delete-organization-metadata.api.mdx] API instead
|
||||||
rpc BulkRemoveOrgMetadata(BulkRemoveOrgMetadataRequest) returns (BulkRemoveOrgMetadataResponse) {
|
rpc BulkRemoveOrgMetadata(BulkRemoveOrgMetadataRequest) returns (BulkRemoveOrgMetadataResponse) {
|
||||||
option (google.api.http) = {
|
option (google.api.http) = {
|
||||||
delete: "/metadata/_bulk"
|
delete: "/metadata/_bulk"
|
||||||
@@ -2404,6 +2405,7 @@ service ManagementService {
|
|||||||
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
||||||
tags: "Organizations";
|
tags: "Organizations";
|
||||||
tags: "Organization Metadata";
|
tags: "Organization Metadata";
|
||||||
|
deprecated: true
|
||||||
summary: "Bulk Delete Metadata";
|
summary: "Bulk Delete Metadata";
|
||||||
description: "Remove a list of metadata objects from an organization with a list of keys."
|
description: "Remove a list of metadata objects from an organization with a list of keys."
|
||||||
parameters: {
|
parameters: {
|
||||||
@@ -2417,7 +2419,7 @@ service ManagementService {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// Deprecated: use AddOrganizationDomain [/v2beta/organization/domain] API instead
|
// Deprecated: use AddOrganizationDomain [apis/resources/org_service_v2beta/organization-service-add-organization-domain.api.mdx] API instead
|
||||||
rpc AddOrgDomain(AddOrgDomainRequest) returns (AddOrgDomainResponse) {
|
rpc AddOrgDomain(AddOrgDomainRequest) returns (AddOrgDomainResponse) {
|
||||||
option (google.api.http) = {
|
option (google.api.http) = {
|
||||||
post: "/orgs/me/domains"
|
post: "/orgs/me/domains"
|
||||||
@@ -2444,7 +2446,7 @@ service ManagementService {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// Deprecated: use ListOrganizationDomains [/v2beta/organization/domain/_search] API instead
|
// Deprecated: use ListOrganizationDomains [apis/resources/org_service_v2beta/organization-service-list-organization-domains.api.mdx] API instead
|
||||||
rpc ListOrgDomains(ListOrgDomainsRequest) returns (ListOrgDomainsResponse) {
|
rpc ListOrgDomains(ListOrgDomainsRequest) returns (ListOrgDomainsResponse) {
|
||||||
option (google.api.http) = {
|
option (google.api.http) = {
|
||||||
post: "/orgs/me/domains/_search"
|
post: "/orgs/me/domains/_search"
|
||||||
@@ -2471,7 +2473,7 @@ service ManagementService {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// Deprecated: use DeleteOrganizationDomain [/v2beta/organization/domain] API instead
|
// Deprecated: use DeleteOrganizationDomain [apis/resources/org_service_v2beta/organization-service-delete-organization-domain.api.mdx] API instead
|
||||||
rpc RemoveOrgDomain(RemoveOrgDomainRequest) returns (RemoveOrgDomainResponse) {
|
rpc RemoveOrgDomain(RemoveOrgDomainRequest) returns (RemoveOrgDomainResponse) {
|
||||||
option (google.api.http) = {
|
option (google.api.http) = {
|
||||||
delete: "/orgs/me/domains/{domain}"
|
delete: "/orgs/me/domains/{domain}"
|
||||||
@@ -2497,7 +2499,7 @@ service ManagementService {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// Deprecated: use GenerateOrganizationDomainValidation [/v2beta/organization/domains/validation/_generate] API instead
|
// Deprecated: use GenerateOrganizationDomainValidation [apis/resources/org_service_v2beta/organization-service-generate-organization-domain-validation.api.mdx] API instead
|
||||||
rpc GenerateOrgDomainValidation(GenerateOrgDomainValidationRequest) returns (GenerateOrgDomainValidationResponse) {
|
rpc GenerateOrgDomainValidation(GenerateOrgDomainValidationRequest) returns (GenerateOrgDomainValidationResponse) {
|
||||||
option (google.api.http) = {
|
option (google.api.http) = {
|
||||||
post: "/orgs/me/domains/{domain}/validation/_generate"
|
post: "/orgs/me/domains/{domain}/validation/_generate"
|
||||||
@@ -2524,7 +2526,7 @@ service ManagementService {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// Deprecated: use VerifyOrganizationDomain [/v2beta/organization/domains/validation/_verify] API instead
|
// Deprecated: use VerifyOrganizationDomain [apis/resources/org_service_v2beta/organization-service-verify-organization-domain.api.mdx] API instead
|
||||||
rpc ValidateOrgDomain(ValidateOrgDomainRequest) returns (ValidateOrgDomainResponse) {
|
rpc ValidateOrgDomain(ValidateOrgDomainRequest) returns (ValidateOrgDomainResponse) {
|
||||||
option (google.api.http) = {
|
option (google.api.http) = {
|
||||||
post: "/orgs/me/domains/{domain}/validation/_validate"
|
post: "/orgs/me/domains/{domain}/validation/_validate"
|
||||||
|
Reference in New Issue
Block a user