docs: deprecate organization v2beta endpoints + remove scim preview notice (#10350)

# Which Problems Are Solved

The documentation API regarding organization v2 beta is not up to date.

The documentation regarding SCIM v2 is not up to date.

# How the Problems Are Solved

- Deprecate the existing v2beta endpoints `CreateOrganization` and
`ListOrganizations` in favour of the v2 counterparst
  - Remove the preview warning from SCIM v2 pages

# Additional Context

- Closes #10311 and #10310

---------

Co-authored-by: Marco Ardizzone <marco@zitadel.com>
This commit is contained in:
elinashoko
2025-07-30 18:41:25 +07:00
committed by Stefan Benz
parent dd35983dca
commit 0cd3b47b16
4 changed files with 9 additions and 21 deletions

View File

@@ -2,15 +2,6 @@
title: SCIM v2.0 (Preview) title: SCIM v2.0 (Preview)
--- ---
:::info
The SCIM v2 interface of Zitadel is currently in a [preview stage](/support/software-release-cycles-support#preview).
It is not yet feature-complete, may contain bugs, and is not generally available.
Do not use it for production yet.
As long as the feature is in a preview state, it will be available for free, it will be put behind a commercial license once it is fully available.
:::
The Zitadel [SCIM v2](https://scim.cloud/) service provider interface enables seamless integration of identity and The Zitadel [SCIM v2](https://scim.cloud/) service provider interface enables seamless integration of identity and
access management (IAM) systems with Zitadel, access management (IAM) systems with Zitadel,
following the System for Cross-domain Identity Management (SCIM) v2.0 specification. following the System for Cross-domain Identity Management (SCIM) v2.0 specification.

View File

@@ -2,15 +2,6 @@
title: SCIM v2.0 (Preview) title: SCIM v2.0 (Preview)
--- ---
:::info
The SCIM v2 interface of Zitadel is currently in a [preview stage](/support/software-release-cycles-support#preview).
It is not yet feature-complete, may contain bugs, and is not generally available.
Do not use it for production yet.
As long as the feature is in a preview state, it will be available for free, it will be put behind a commercial license once it is fully available.
:::
The Zitadel [SCIM v2](https://scim.cloud/) service provider interface enables seamless integration of identity and The Zitadel [SCIM v2](https://scim.cloud/) service provider interface enables seamless integration of identity and
access management (IAM) systems with Zitadel, access management (IAM) systems with Zitadel,
following the System for Cross-domain Identity Management (SCIM) v2.0 specification. following the System for Cross-domain Identity Management (SCIM) v2.0 specification.

View File

@@ -751,10 +751,10 @@ module.exports = {
label: "Organization (Beta)", label: "Organization (Beta)",
link: { link: {
type: "generated-index", type: "generated-index",
title: "Organization Service beta API", title: "Organization Service Beta API",
slug: "/apis/resources/org_service/v2beta", slug: "/apis/resources/org_service/v2beta",
description: description:
"This API is intended to manage organizations for ZITADEL. \n", "This beta API is intended to manage organizations for ZITADEL. Expect breaking changes to occur. Please use the v2 version for a stable API. \n",
}, },
items: sidebar_api_org_service_v2beta, items: sidebar_api_org_service_v2beta,
}, },

View File

@@ -115,6 +115,8 @@ service OrganizationService {
// //
// Required permission: // Required permission:
// - `org.create` // - `org.create`
//
// Deprecated: Use [AddOrganization](/apis/resources/org_service_v2/organization-service-add-organization.api.mdx) instead to create an organization.
rpc CreateOrganization(CreateOrganizationRequest) returns (CreateOrganizationResponse) { rpc CreateOrganization(CreateOrganizationRequest) returns (CreateOrganizationResponse) {
option (google.api.http) = { option (google.api.http) = {
post: "/v2beta/organizations" post: "/v2beta/organizations"
@@ -140,6 +142,7 @@ service OrganizationService {
description: "The organization to create already exists."; description: "The organization to create already exists.";
} }
}; };
deprecated: true;
}; };
} }
@@ -190,6 +193,8 @@ service OrganizationService {
// //
// Required permission: // Required permission:
// - `iam.read` // - `iam.read`
//
// Deprecated: Use [ListOrganizations](/apis/resources/org_service_v2/organization-service-list-organizations.api.mdx) instead to list organizations.
rpc ListOrganizations(ListOrganizationsRequest) returns (ListOrganizationsResponse) { rpc ListOrganizations(ListOrganizationsRequest) returns (ListOrganizationsResponse) {
option (google.api.http) = { option (google.api.http) = {
post: "/v2beta/organizations/search"; post: "/v2beta/organizations/search";
@@ -206,6 +211,7 @@ service OrganizationService {
responses: { responses: {
key: "200"; key: "200";
}; };
deprecated: true;
}; };
} }