mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-11 20:27:32 +00:00
chore(api): initial definition of API for user schemas (user v3 and user schema v3 service) (#7372)
Adds the initial proto definition for a new user service (v3) based on user schema and it's corresponding user schema service (v3)
This commit is contained in:
Livio Spring
337
docs/sidebars.js
337
docs/sidebars.js
@@ -521,129 +521,238 @@ module.exports = {
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Core Resources",
|
||||
slug: "/apis/resources/",
|
||||
description: "Resource based API definitions",
|
||||
slug: "/apis/apis/",
|
||||
description:
|
||||
"ZITADEL provides multiple APIs to manage the system, instances and resources such as users, projects and more.\n" +
|
||||
"\n" +
|
||||
"There are multiple different versions and multiple services available:"+
|
||||
"\n" +
|
||||
"The resource based APIs are, as the name suggests, organized by resources such as users, session, settings and more.\n" +
|
||||
"These services are the future of the ZITADEL APIS and the best way to start integrating ZITADEL.\n" +
|
||||
"\n"+
|
||||
"The service based APIs are organized by UseCase/Context, such as Auth API for authenticated users,"+
|
||||
"Management API for organization managers, Admin API for instance managers and a System API for system managers.",
|
||||
},
|
||||
items: [
|
||||
{
|
||||
type: "category",
|
||||
label: "Authenticated User",
|
||||
label: "Service Based (V1)",
|
||||
collapsed: false,
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Auth API",
|
||||
slug: "/apis/resources/auth",
|
||||
title: "Service Based APIs (V1)",
|
||||
slug: "/apis/services/",
|
||||
description:
|
||||
"The authentication API (aka Auth API) is used for all operations on the currently logged in user. The user id is taken from the sub claim in the token.",
|
||||
},
|
||||
items: require("./docs/apis/resources/auth/sidebar.js"),
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Organization Objects",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Management API",
|
||||
slug: "/apis/resources/mgmt",
|
||||
description:
|
||||
"The management API is as the name states the interface where systems can mutate IAM objects like, organizations, projects, clients, users and so on if they have the necessary access rights. To identify the current organization you can send a header x-zitadel-orgid or if no header is set, the organization of the authenticated user is set.",
|
||||
},
|
||||
items: require("./docs/apis/resources/mgmt/sidebar.js"),
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Instance Objects",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Admin API",
|
||||
slug: "/apis/resources/admin",
|
||||
description:
|
||||
"This API is intended to configure and manage one ZITADEL instance itself.",
|
||||
},
|
||||
items: require("./docs/apis/resources/admin/sidebar.js"),
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Instance Lifecycle",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "System API",
|
||||
slug: "/apis/resources/system",
|
||||
description:
|
||||
"This API is intended to manage the different ZITADEL instances within the system.\n" +
|
||||
"\n" +
|
||||
"Checkout the guide how to access the ZITADEL System API.",
|
||||
},
|
||||
items: require("./docs/apis/resources/system/sidebar.js"),
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "User Lifecycle (Beta)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "User Service API (Beta)",
|
||||
slug: "/apis/resources/user_service",
|
||||
description:
|
||||
"This API is intended to manage users in a ZITADEL instance.\n" +
|
||||
"\n" +
|
||||
"This project is in beta state. It can AND will continue breaking until the services provide the same functionality as the current login.",
|
||||
},
|
||||
items: require("./docs/apis/resources/user_service/sidebar.js"),
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Session Lifecycle (Beta)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Session Service API (Beta)",
|
||||
slug: "/apis/resources/session_service",
|
||||
description:
|
||||
"This API is intended to manage sessions in a ZITADEL instance.\n" +
|
||||
"\n" +
|
||||
"This project is in beta state. It can AND will continue breaking until the services provide the same functionality as the current login.",
|
||||
},
|
||||
items: require("./docs/apis/resources/session_service/sidebar.js"),
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "OIDC Lifecycle (Beta)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "OIDC Service API (Beta)",
|
||||
slug: "/apis/resources/oidc_service",
|
||||
description:
|
||||
"Get OIDC Auth Request details and create callback URLs.\n" +
|
||||
"\n" +
|
||||
"This project is in beta state. It can AND will continue breaking until the services provide the same functionality as the current login.",
|
||||
},
|
||||
items: require("./docs/apis/resources/oidc_service/sidebar.js"),
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Settings Lifecycle (Beta)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Settings Service API (Beta)",
|
||||
slug: "/apis/resources/settings_service",
|
||||
description:
|
||||
"This API is intended to manage settings in a ZITADEL instance.\n" +
|
||||
"\n" +
|
||||
"This project is in beta state. It can AND will continue to break until the services provide the same functionality as the current login.",
|
||||
},
|
||||
items: require("./docs/apis/resources/settings_service/sidebar.js"),
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Execution Lifecycle (Alpha)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Execution Service API (Alpha)",
|
||||
slug: "/apis/resources/execution_service_v3",
|
||||
description:
|
||||
"This API is intended to manage custom executions (previously known as actions) in a ZITADEL instance.\n"+
|
||||
"The service based APIs are organized by UseCase/Context, such as Auth API for authenticated users,"+
|
||||
"Management API for organization managers, Admin API for instance managers and a System API for system managers.\n"+
|
||||
"\n"+
|
||||
"This project is in alpha state. It can AND will continue breaking until the services provide the same functionality as the current actions.",
|
||||
"To improve the developer experience in managing the different resources, ZITADEL also offers Resource Based APIs (v2 and v3). "+
|
||||
"Those APIs focus on the resources themselves. For example they offer a User Service, which will give you the possibility " +
|
||||
"to search for users across multiple organizations.\n"+
|
||||
"Note that the Resource Based APIs are not yet generally available. Please check the corresponding service" +
|
||||
"for their state and functionality.",
|
||||
},
|
||||
items: require("./docs/apis/resources/execution_service_v3/sidebar.js"),
|
||||
items: [
|
||||
{
|
||||
type: "category",
|
||||
label: "Authenticated User",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Auth API",
|
||||
slug: "/apis/resources/auth",
|
||||
description:
|
||||
"The authentication API (aka Auth API) is used for all operations on the currently logged in user. The user id is taken from the sub claim in the token.",
|
||||
},
|
||||
items: require("./docs/apis/resources/auth/sidebar.js"),
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Organization Objects",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Management API",
|
||||
slug: "/apis/resources/mgmt",
|
||||
description:
|
||||
"The management API is as the name states the interface where systems can mutate IAM objects like, organizations, projects, clients, users and so on if they have the necessary access rights. To identify the current organization you can send a header x-zitadel-orgid or if no header is set, the organization of the authenticated user is set.",
|
||||
},
|
||||
items: require("./docs/apis/resources/mgmt/sidebar.js"),
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Instance Objects",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Admin API",
|
||||
slug: "/apis/resources/admin",
|
||||
description:
|
||||
"This API is intended to configure and manage one ZITADEL instance itself.",
|
||||
},
|
||||
items: require("./docs/apis/resources/admin/sidebar.js"),
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Instance Lifecycle",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "System API",
|
||||
slug: "/apis/resources/system",
|
||||
description:
|
||||
"This API is intended to manage the different ZITADEL instances within the system.\n" +
|
||||
"\n" +
|
||||
"Checkout the guide how to access the ZITADEL System API.",
|
||||
},
|
||||
items: require("./docs/apis/resources/system/sidebar.js"),
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Resource Based (V2)",
|
||||
collapsed: false,
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Resource Based APIs (V2)",
|
||||
slug: "/apis/resources/",
|
||||
description:
|
||||
"The resource based APIs are, as the name suggest, organized by resources such as users, session, settings and more. "+
|
||||
"Check the list below to get an overview of all available resources.\n"+
|
||||
"\n"+
|
||||
"While the service based APIs (V1) work great for use cases in a specific context such as a single organization, " +
|
||||
"it's sometime difficult to know which API to use, particularly for resources across multiple organizations. "+
|
||||
"For instance, SearchUsers on an Instance level or on an Organization level.\n"+
|
||||
"This is exactly where the resource based APIs come in place, e.g. with the User Service, " +
|
||||
"where you're able to search all users and can provide the context (organization) yourself if needed or just search the whole instance.\n"+
|
||||
"\n"+
|
||||
"Note that these APIs are not yet generally available and therefore breaking changes might still occur.\n"+
|
||||
"Please check the corresponding service for more information on the state and availability.",
|
||||
},
|
||||
items: [
|
||||
{
|
||||
type: "category",
|
||||
label: "User Lifecycle (Beta)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "User Service API (Beta)",
|
||||
slug: "/apis/resources/user_service",
|
||||
description:
|
||||
"This API is intended to manage users in a ZITADEL instance.\n" +
|
||||
"\n" +
|
||||
"This project is in beta state. It can AND will continue breaking until the services provide the same functionality as the current login.",
|
||||
},
|
||||
items: require("./docs/apis/resources/user_service/sidebar.js"),
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Session Lifecycle (Beta)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Session Service API (Beta)",
|
||||
slug: "/apis/resources/session_service",
|
||||
description:
|
||||
"This API is intended to manage sessions in a ZITADEL instance.\n" +
|
||||
"\n" +
|
||||
"This project is in beta state. It can AND will continue breaking until the services provide the same functionality as the current login.",
|
||||
},
|
||||
items: require("./docs/apis/resources/session_service/sidebar.js"),
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "OIDC Lifecycle (Beta)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "OIDC Service API (Beta)",
|
||||
slug: "/apis/resources/oidc_service",
|
||||
description:
|
||||
"Get OIDC Auth Request details and create callback URLs.\n" +
|
||||
"\n" +
|
||||
"This project is in beta state. It can AND will continue breaking until the services provide the same functionality as the current login.",
|
||||
},
|
||||
items: require("./docs/apis/resources/oidc_service/sidebar.js"),
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Settings Lifecycle (Beta)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Settings Service API (Beta)",
|
||||
slug: "/apis/resources/settings_service",
|
||||
description:
|
||||
"This API is intended to manage settings in a ZITADEL instance.\n" +
|
||||
"\n" +
|
||||
"This project is in beta state. It can AND will continue to break until the services provide the same functionality as the current login.",
|
||||
},
|
||||
items: require("./docs/apis/resources/settings_service/sidebar.js"),
|
||||
},
|
||||
]
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Resource Based (V3)",
|
||||
collapsed: false,
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Resource Based APIs (V3)",
|
||||
slug: "/apis/resources_v3/",
|
||||
description:
|
||||
"The resource based APIs are, as the name suggests, organized by resources such as users, session, settings and more.\n"+
|
||||
"\n"+
|
||||
"While the service based APIs (V1) work great for use cases in a specific context such as a single organization, " +
|
||||
"it's sometime difficult to know which API to use, particularly for resources across multiple organizations. "+
|
||||
"For instance, SearchUsers on an Instance level or on an Organization level.\n"+
|
||||
"This is exactly where the resource based APIs come in place, e.g. with the User Service, " +
|
||||
"where you're able to search all users and can provide the context (organization) yourself if needed or just search the whole instance.\n"+
|
||||
"\n"+
|
||||
"Version 3 offers more customization than the V2 resource bases APIs. You can define your own user schema "+
|
||||
"to be able to manage users based on these schemas and customize various behaviors, such as manipulating "+
|
||||
"inbound API calls, call webhooks on different event and more with the execution service.\n"+
|
||||
"\n"+
|
||||
"Note that these APIs are not yet generally available and therefore breaking changes might still occur.\n"+
|
||||
"Please check the corresponding service for more information on the state and availability.",
|
||||
},
|
||||
items: [
|
||||
{
|
||||
type: "category",
|
||||
label: "User Schema Lifecycle (Alpha)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "User Schema Service API (Aplha)",
|
||||
slug: "/apis/resources/user_schema_service",
|
||||
description:
|
||||
"This API is intended to manage data schemas for users in a ZITADEL instance.\n" +
|
||||
"\n" +
|
||||
"This project is in alpha state. It can AND will continue breaking until the service provides the same functionality as the v1 and v2 user services.",
|
||||
},
|
||||
items: require("./docs/apis/resources/user_schema_service_v3/sidebar.js"),
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "User Lifecycle (Alpha)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "User Service API (Aplha)",
|
||||
slug: "/apis/resources/user_service_v3",
|
||||
description:
|
||||
"This API is intended to manage users with your own data schema in a ZITADEL instance.\n"+
|
||||
"\n"+
|
||||
"This project is in alpha state. It can AND will continue breaking until the service provides the same functionality as the v1 and v2 user services."
|
||||
},
|
||||
items: require("./docs/apis/resources/user_service_v3/sidebar.js"),
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Execution Lifecycle (Alpha)",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Execution Service API (Alpha)",
|
||||
slug: "/apis/resources/execution_service_v3",
|
||||
description:
|
||||
"This API is intended to manage custom executions (previously known as actions) in a ZITADEL instance.\n"+
|
||||
"\n"+
|
||||
"This project is in alpha state. It can AND will continue breaking until the services provide the same functionality as the current actions.",
|
||||
},
|
||||
items: require("./docs/apis/resources/execution_service_v3/sidebar.js"),
|
||||
},
|
||||
]
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
|
||||
Reference in New Issue
Block a user