mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-11 20:07:32 +00:00
docs(api): add new beta services to api reference (#10018)
# Which Problems Are Solved The unreleased new resource apis have been removed from the docs: https://github.com/zitadel/zitadel/pull/10015 # How the Problems Are Solved Add them to the docs sidenav again, since they're now released. # Additional Changes none # Additional Context none --------- Co-authored-by: Fabienne <fabienne.gerschwiler@gmail.com> Co-authored-by: Marco Ardizzone <marco@zitadel.com>
This commit is contained in:
Livio Spring
444
docs/sidebars.js
444
docs/sidebars.js
@@ -664,6 +664,228 @@ module.exports = {
|
||||
id: "apis/apis/index",
|
||||
},
|
||||
items: [
|
||||
|
||||
{
|
||||
type: "category",
|
||||
label: "V2",
|
||||
collapsed: false,
|
||||
link: {
|
||||
type: "doc",
|
||||
id: "apis/v2",
|
||||
},
|
||||
items: [
|
||||
{
|
||||
type: "category",
|
||||
label: "User",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "User Service API",
|
||||
slug: "/apis/resources/user_service_v2",
|
||||
description:
|
||||
"This API is intended to manage users in a ZITADEL instance.\n",
|
||||
},
|
||||
items: sidebar_api_user_service_v2,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Session",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Session Service API",
|
||||
slug: "/apis/resources/session_service_v2",
|
||||
description:
|
||||
"This API is intended to manage sessions in a ZITADEL instance.\n",
|
||||
},
|
||||
items: sidebar_api_session_service_v2,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "OIDC",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "OIDC Service API",
|
||||
slug: "/apis/resources/oidc_service_v2",
|
||||
description:
|
||||
"Get OIDC Auth Request details and create callback URLs.\n",
|
||||
},
|
||||
items: sidebar_api_oidc_service_v2,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Settings",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Settings Service API",
|
||||
slug: "/apis/resources/settings_service_v2",
|
||||
description:
|
||||
"This API is intended to manage settings in a ZITADEL instance.\n",
|
||||
},
|
||||
items: sidebar_api_settings_service_v2,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Feature",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Feature Service API",
|
||||
slug: "/apis/resources/feature_service_v2",
|
||||
description:
|
||||
'This API is intended to manage features for ZITADEL. Feature settings that are available on multiple "levels", such as instance and organization. The higher level instance acts as a default for the lower level. When a feature is set on multiple levels, the lower level takes precedence. Features can be experimental where ZITADEL will assume a sane default, such as disabled. When over time confidence in such a feature grows, ZITADEL can default to enabling the feature. As a final step we might choose to always enable a feature and remove the setting from this API, reserving the proto field number. Such removal is not considered a breaking change. Setting a removed field will effectively result in a no-op.\n',
|
||||
},
|
||||
items: sidebar_api_feature_service_v2,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Organization",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Organization Service API",
|
||||
slug: "/apis/resources/org_service/v2",
|
||||
description:
|
||||
"This API is intended to manage organizations for ZITADEL. \n",
|
||||
},
|
||||
items: sidebar_api_org_service_v2,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Organization (Beta)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Organization Service beta API",
|
||||
slug: "/apis/resources/org_service/v2beta",
|
||||
description:
|
||||
"This API is intended to manage organizations for ZITADEL. \n",
|
||||
},
|
||||
items: sidebar_api_org_service_v2beta,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Identity Provider",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Identity Provider Service API",
|
||||
slug: "/apis/resources/idp_service_v2",
|
||||
description:
|
||||
"This API is intended to manage identity providers (IdPs) for ZITADEL.\n",
|
||||
},
|
||||
items: sidebar_api_idp_service_v2,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Web Key",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Web Key Service API",
|
||||
slug: "/apis/resources/webkey_service_v2",
|
||||
description:
|
||||
"This API is intended to manage web keys for a ZITADEL instance, used to sign and validate OIDC tokens.\n" +
|
||||
"\n"+
|
||||
"The public key endpoint (outside of this service) is used to retrieve the public keys of the active and inactive keys.\n",
|
||||
},
|
||||
items: sidebar_api_webkey_service_v2
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Action (Beta)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Action Service API (Beta)",
|
||||
slug: "/apis/resources/action_service_v2",
|
||||
description:
|
||||
"This API is intended to manage custom executions and targets (previously known as actions) in a ZITADEL instance.\n" +
|
||||
"\n" +
|
||||
"This service is in beta state. It can AND will continue breaking until a stable version is released.\n"+
|
||||
"\n" +
|
||||
"The version 2 of actions provide much more options to customize ZITADELs behaviour than previous action versions.\n" +
|
||||
"Also, v2 actions are available instance-wide, whereas previous actions had to be managed for each organization individually\n" +
|
||||
"ZITADEL doesn't restrict the implementation languages, tooling and runtime for v2 action executions anymore.\n" +
|
||||
"Instead, it calls external endpoints which are implemented and maintained by action v2 users.\n"+
|
||||
"\n" +
|
||||
"Please make sure to enable the `actions` feature flag on your instance to use this service and that you're running Zitadel V3.",
|
||||
},
|
||||
items: sidebar_api_actions_v2,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Instance (Beta)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Instance Service API (Beta)",
|
||||
slug: "/apis/resources/instance_service_v2",
|
||||
description:
|
||||
"This API is intended to manage instances, custom domains and trusted domains in ZITADEL.\n" +
|
||||
"\n" +
|
||||
"This service is in beta state. It can AND will continue breaking until a stable version is released.\n"+
|
||||
"\n" +
|
||||
"This v2 of the API provides the same functionalities as the v1, but organised on a per resource basis.\n" +
|
||||
"The whole functionality related to domains (custom and trusted) has been moved under this instance API."
|
||||
,
|
||||
},
|
||||
items: sidebar_api_instance_service_v2,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Project (Beta)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Project Service API (Beta)",
|
||||
slug: "/apis/resources/project_service_v2",
|
||||
description:
|
||||
"This API is intended to manage projects and subresources for ZITADEL. \n" +
|
||||
"\n" +
|
||||
"This service is in beta state. It can AND will continue breaking until a stable version is released.",
|
||||
},
|
||||
items: sidebar_api_project_service_v2,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "App (Beta)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Application Service API (Beta)",
|
||||
slug: "/apis/resources/application_service_v2",
|
||||
description:
|
||||
"This API lets you manage Zitadel applications (API, SAML, OIDC).\n"+
|
||||
"\n"+
|
||||
"The API offers generic endpoints that work for all app types (API, SAML, OIDC), "+
|
||||
"\n"+
|
||||
"This API is in beta state. It can AND will continue breaking until a stable version is released.\n"
|
||||
},
|
||||
items: sidebar_api_app_v2,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Authorizations (Beta)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Authorization Service API (Beta)",
|
||||
slug: "/apis/resources/authorization_service_v2",
|
||||
description:
|
||||
"AuthorizationService provides methods to manage authorizations for users within your projects and applications.\n" +
|
||||
"\n" +
|
||||
"For managing permissions and roles for ZITADEL internal resources, like organizations, projects,\n" +
|
||||
"users, etc., please use the InternalPermissionService."+
|
||||
"\n"+
|
||||
"This API is in beta state. It can AND will continue breaking until a stable version is released.\n"
|
||||
},
|
||||
items: sidebar_api_authorization_service_v2,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Permissions (Beta)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Permission Service API (Beta)",
|
||||
slug: "/apis/resources/permission_service_v2",
|
||||
description:
|
||||
"This API is intended to manage internal permissions in ZITADEL.\n" +
|
||||
"\n"+
|
||||
"This API is in beta state. It can AND will continue breaking until a stable version is released.\n"
|
||||
},
|
||||
items: sidebar_api_permission_service_v2,
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "V1",
|
||||
@@ -726,227 +948,7 @@ module.exports = {
|
||||
},
|
||||
items: sidebar_api_system,
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "V2",
|
||||
collapsed: false,
|
||||
link: {
|
||||
type: "doc",
|
||||
id: "apis/v2",
|
||||
},
|
||||
items: [
|
||||
{
|
||||
type: "category",
|
||||
label: "User",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "User Service API",
|
||||
slug: "/apis/resources/user_service_v2",
|
||||
description:
|
||||
"This API is intended to manage users in a ZITADEL instance.\n",
|
||||
},
|
||||
items: sidebar_api_user_service_v2,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Session",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Session Service API",
|
||||
slug: "/apis/resources/session_service_v2",
|
||||
description:
|
||||
"This API is intended to manage sessions in a ZITADEL instance.\n",
|
||||
},
|
||||
items: sidebar_api_session_service_v2,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "OIDC",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "OIDC Service API",
|
||||
slug: "/apis/resources/oidc_service_v2",
|
||||
description:
|
||||
"Get OIDC Auth Request details and create callback URLs.\n",
|
||||
},
|
||||
items: sidebar_api_oidc_service_v2,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Settings",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Settings Service API",
|
||||
slug: "/apis/resources/settings_service_v2",
|
||||
description:
|
||||
"This API is intended to manage settings in a ZITADEL instance.\n",
|
||||
},
|
||||
items: sidebar_api_settings_service_v2,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Feature",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Feature Service API",
|
||||
slug: "/apis/resources/feature_service_v2",
|
||||
description:
|
||||
'This API is intended to manage features for ZITADEL. Feature settings that are available on multiple "levels", such as instance and organization. The higher level instance acts as a default for the lower level. When a feature is set on multiple levels, the lower level takes precedence. Features can be experimental where ZITADEL will assume a sane default, such as disabled. When over time confidence in such a feature grows, ZITADEL can default to enabling the feature. As a final step we might choose to always enable a feature and remove the setting from this API, reserving the proto field number. Such removal is not considered a breaking change. Setting a removed field will effectively result in a no-op.\n',
|
||||
},
|
||||
items: sidebar_api_feature_service_v2,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Organization",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Organization Service API",
|
||||
slug: "/apis/resources/org_service/v2",
|
||||
description:
|
||||
"This API is intended to manage organizations for ZITADEL. \n",
|
||||
},
|
||||
items: sidebar_api_org_service_v2,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Organization (Beta)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Organization Service beta API",
|
||||
slug: "/apis/resources/org_service/v2beta",
|
||||
description:
|
||||
"This API is intended to manage organizations for ZITADEL. \n",
|
||||
},
|
||||
items: sidebar_api_org_service_v2beta,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Identity Provider",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Identity Provider Service API",
|
||||
slug: "/apis/resources/idp_service_v2",
|
||||
description:
|
||||
"This API is intended to manage identity providers (IdPs) for ZITADEL.\n",
|
||||
},
|
||||
items: sidebar_api_idp_service_v2,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Web Key",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Web Key Service API",
|
||||
slug: "/apis/resources/webkey_service_v2",
|
||||
description:
|
||||
"This API is intended to manage web keys for a ZITADEL instance, used to sign and validate OIDC tokens.\n" +
|
||||
"\n"+
|
||||
"The public key endpoint (outside of this service) is used to retrieve the public keys of the active and inactive keys.\n",
|
||||
},
|
||||
items: sidebar_api_webkey_service_v2
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Action (Beta)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Action Service API (Beta)",
|
||||
slug: "/apis/resources/action_service_v2",
|
||||
description:
|
||||
"This API is intended to manage custom executions and targets (previously known as actions) in a ZITADEL instance.\n" +
|
||||
"\n" +
|
||||
"This service is in beta state. It can AND will continue breaking until a stable version is released.\n"+
|
||||
"\n" +
|
||||
"The version 2 of actions provide much more options to customize ZITADELs behaviour than previous action versions.\n" +
|
||||
"Also, v2 actions are available instance-wide, whereas previous actions had to be managed for each organization individually\n" +
|
||||
"ZITADEL doesn't restrict the implementation languages, tooling and runtime for v2 action executions anymore.\n" +
|
||||
"Instead, it calls external endpoints which are implemented and maintained by action v2 users.\n"+
|
||||
"\n" +
|
||||
"Please make sure to enable the `actions` feature flag on your instance to use this service and that you're running Zitadel V3.",
|
||||
},
|
||||
items: sidebar_api_actions_v2,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Project (Beta)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Project Service API (Beta)",
|
||||
slug: "/apis/resources/project_service_v2",
|
||||
description:
|
||||
"This API is intended to manage projects and subresources for ZITADEL. \n" +
|
||||
"\n" +
|
||||
"This service is in beta state. It can AND will continue breaking until a stable version is released.",
|
||||
},
|
||||
items: sidebar_api_project_service_v2,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Instance (Beta)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Instance Service API (Beta)",
|
||||
slug: "/apis/resources/instance_service_v2",
|
||||
description:
|
||||
"This API is intended to manage instances, custom domains and trusted domains in ZITADEL.\n" +
|
||||
"\n" +
|
||||
"This service is in beta state. It can AND will continue breaking until a stable version is released.\n"+
|
||||
"\n" +
|
||||
"This v2 of the API provides the same functionalities as the v1, but organised on a per resource basis.\n" +
|
||||
"The whole functionality related to domains (custom and trusted) has been moved under this instance API."
|
||||
,
|
||||
},
|
||||
items: sidebar_api_instance_service_v2,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "App (Beta)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Application Service API (Beta)",
|
||||
slug: "/apis/resources/application_service_v2",
|
||||
description:
|
||||
"This API lets you manage Zitadel applications (API, SAML, OIDC).\n"+
|
||||
"\n"+
|
||||
"The API offers generic endpoints that work for all app types (API, SAML, OIDC), "+
|
||||
"\n"+
|
||||
"This API is in beta state. It can AND will continue breaking until a stable version is released.\n"
|
||||
},
|
||||
items: sidebar_api_app_v2,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Authorizations (Beta)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Authorization Service API (Beta)",
|
||||
slug: "/apis/resources/authorization_service_v2",
|
||||
description:
|
||||
"AuthorizationService provides methods to manage authorizations for users within your projects and applications.\n" +
|
||||
"\n" +
|
||||
"For managing permissions and roles for ZITADEL internal resources, like organizations, projects,\n" +
|
||||
"users, etc., please use the InternalPermissionService."+
|
||||
"\n"+
|
||||
"This API is in beta state. It can AND will continue breaking until a stable version is released.\n"
|
||||
},
|
||||
items: sidebar_api_authorization_service_v2,
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Permissions (Beta)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Permission Service API (Beta)",
|
||||
slug: "/apis/resources/permission_service_v2",
|
||||
description:
|
||||
"This API is intended to manage internal permissions in ZITADEL.\n" +
|
||||
"\n"+
|
||||
"This API is in beta state. It can AND will continue breaking until a stable version is released.\n"
|
||||
},
|
||||
items: sidebar_api_permission_service_v2,
|
||||
},
|
||||
"apis/migration_v1_to_v2"
|
||||
],
|
||||
},
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user