diff --git a/docs/docs/examples/introduction.mdx b/docs/docs/examples/introduction.mdx index 49ac1a834d..b80d2ecb33 100644 --- a/docs/docs/examples/introduction.mdx +++ b/docs/docs/examples/introduction.mdx @@ -174,9 +174,9 @@ Our examples cover a range of programming languages and frameworks, so no matter node - NodeJS - - + Node.js NestJS API + + Guide diff --git a/docs/sidebars.js b/docs/sidebars.js index cafcdfc4d6..ea4cb5a13c 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -25,7 +25,8 @@ module.exports = { items: [ "examples/secure-api/go", "examples/secure-api/python-flask", - "examples/secure-api/dot-net" + "examples/secure-api/dot-net", + "examples/secure-api/nodejs-nestjs", ], collapsed: true, }, @@ -38,15 +39,15 @@ module.exports = { items: [ "examples/introduction", { - type: 'link', - label: 'Frontend', // The link label - href: '/examples/introduction#frontend', // The internal path + type: "link", + label: "Frontend", // The link label + href: "/examples/introduction#frontend", // The internal path }, { - type: 'link', - label: 'Backend', // The link label - href: '/examples/introduction#backend', // The internal path - } + type: "link", + label: "Backend", // The link label + href: "/examples/introduction#backend", // The internal path + }, ], collapsed: true, }, @@ -128,9 +129,9 @@ module.exports = { "guides/migrate/sources/zitadel", "guides/migrate/sources/auth0", "guides/migrate/sources/keycloak", - ] + ], }, - ] + ], }, { type: "category", @@ -151,8 +152,7 @@ module.exports = { type: "generated-index", title: "Authenticate Human Users", slug: "guides/integrate/human-users", - description: - "How to authenticate human users with OpenID Connect", + description: "How to authenticate human users with OpenID Connect", }, items: [ "guides/integrate/login-users", @@ -197,9 +197,7 @@ module.exports = { type: "category", label: "Role Management", collapsed: true, - items: [ - "guides/integrate/retrieve-user-roles" - ], + items: ["guides/integrate/retrieve-user-roles"], }, { type: "category", @@ -209,8 +207,7 @@ module.exports = { title: "Build your own Login UI", slug: "/guides/integrate/login-ui", description: - "In the following guides you will learn how to create your own login UI with our APIs. The different scenarios like username/password, external identity provider, etc. will be shown." - + "In the following guides you will learn how to create your own login UI with our APIs. The different scenarios like username/password, external identity provider, etc. will be shown.", }, collapsed: true, items: [ @@ -221,7 +218,7 @@ module.exports = { "guides/integrate/login-ui/select-account", "guides/integrate/login-ui/password-reset", "guides/integrate/login-ui/logout", - "guides/integrate/login-ui/oidc-standard" + "guides/integrate/login-ui/oidc-standard", ], }, { @@ -229,11 +226,11 @@ module.exports = { label: "Configure Identity Providers", link: { type: "generated-index", - title: "Let Users Login with Preferred Identity Provider in ZITADEL", + title: + "Let Users Login with Preferred Identity Provider in ZITADEL", slug: "/guides/integrate/identity-providers", description: "In the following guides you will learn how to configure and setup your preferred external identity provider in ZITADEL.", - }, collapsed: true, items: [ @@ -255,9 +252,9 @@ module.exports = { collapsed: true, items: [ { - type: 'link', - label: 'Authenticate Service Users', - href: '/guides/integrate/serviceusers', + type: "link", + label: "Authenticate Service Users", + href: "/guides/integrate/serviceusers", }, "guides/integrate/access-zitadel-apis", "guides/integrate/access-zitadel-system-api", @@ -282,48 +279,47 @@ module.exports = { slug: "/guides/integrate/services", description: "With the guides in this section you will learn how to integrate ZITADEL with your services.", - }, collapsed: true, items: [ { - type: 'autogenerated', - dirName: 'guides/integrate/services', + type: "autogenerated", + dirName: "guides/integrate/services", }, { - type: 'link', - label: 'Bold BI (boldbi.com)', - href: 'https://support.boldbi.com/kb/article/13708/how-to-configure-zitadel-oauth-login-in-bold-bi', + type: "link", + label: "Bold BI (boldbi.com)", + href: "https://support.boldbi.com/kb/article/13708/how-to-configure-zitadel-oauth-login-in-bold-bi", }, { - type: 'link', - label: 'Cloudflare workers', - href: 'https://zitadel.com/blog/increase-spa-security-with-cloudflare-workers', + type: "link", + label: "Cloudflare workers", + href: "https://zitadel.com/blog/increase-spa-security-with-cloudflare-workers", }, { - type: 'link', - label: 'Firezone (firezone.dev)', - href: 'https://www.firezone.dev/docs/authenticate/oidc/zitadel', + type: "link", + label: "Firezone (firezone.dev)", + href: "https://www.firezone.dev/docs/authenticate/oidc/zitadel", }, { - type: 'link', - label: 'Nextcloud', - href: 'https://zitadel.com/blog/zitadel-as-sso-provider-for-selfhosting', + type: "link", + label: "Nextcloud", + href: "https://zitadel.com/blog/zitadel-as-sso-provider-for-selfhosting", }, { - type: 'link', - label: 'Netbird (netbird.io)', - href: 'https://docs.netbird.io/selfhosted/identity-providers', + type: "link", + label: "Netbird (netbird.io)", + href: "https://docs.netbird.io/selfhosted/identity-providers", }, { - type: 'link', - label: 'Psono (psono.com)', - href: 'https://doc.psono.com/admin/configuration/oidc-zitadel.html', + type: "link", + label: "Psono (psono.com)", + href: "https://doc.psono.com/admin/configuration/oidc-zitadel.html", }, { - type: 'link', - label: 'Zoho Desk (zoho.com)', - href: 'https://help.zoho.com/portal/en/kb/desk/user-management-and-security/data-security/articles/setting-up-saml-single-signon-for-help-center#Zitadel_IDP', + type: "link", + label: "Zoho Desk (zoho.com)", + href: "https://help.zoho.com/portal/en/kb/desk/user-management-and-security/data-security/articles/setting-up-saml-single-signon-for-help-center#Zitadel_IDP", }, ], }, @@ -336,18 +332,17 @@ module.exports = { slug: "/guides/integrate/tools", description: "With the guides in this section you will learn how to integrate ZITADEL with your favorite tools.", - }, collapsed: true, items: [ { - type: 'link', - label: 'Argo CD', - href: 'https://argo-cd.readthedocs.io/en/latest/operator-manual/user-management/zitadel/', + type: "link", + label: "Argo CD", + href: "https://argo-cd.readthedocs.io/en/latest/operator-manual/user-management/zitadel/", }, "guides/integrate/tools/apache2", "guides/integrate/authenticated-mongodb-charts", - "examples/identity-proxy/oauth2-proxy" + "examples/identity-proxy/oauth2-proxy", ], }, ], @@ -398,7 +393,7 @@ module.exports = { "concepts/features/actions", "concepts/features/audit-trail", "concepts/features/selfservice", - ] + ], }, { type: "category", @@ -418,7 +413,7 @@ module.exports = { "concepts/eventstore/implementation", ], }, - ] + ], }, { type: "category", @@ -428,26 +423,26 @@ module.exports = { "support/software-release-cycles-support", "support/troubleshooting", { - type: 'link', - label: 'Support Service Descriptions', - href: '/legal/service-description/support-services', + type: "link", + label: "Support Service Descriptions", + href: "/legal/service-description/support-services", }, { - type: 'category', + type: "category", label: "Technical Advisory", link: { - type: 'doc', - id: 'support/technical_advisory', + type: "doc", + id: "support/technical_advisory", }, collapsed: true, items: [ - { - type: 'autogenerated', - dirName: 'support/advisory', - }, + { + type: "autogenerated", + dirName: "support/advisory", + }, ], }, - ] + ], }, ], apis: [ @@ -460,8 +455,7 @@ module.exports = { type: "generated-index", title: "Core Resources", slug: "/apis/resources/", - description: - "Resource based API definitions", + description: "Resource based API definitions", }, items: [ { @@ -473,7 +467,6 @@ module.exports = { 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"), }, @@ -523,8 +516,8 @@ module.exports = { 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 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"), @@ -537,8 +530,8 @@ module.exports = { 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 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"), @@ -551,8 +544,8 @@ module.exports = { title: "OIDC Service API (Beta)", slug: "/apis/resources/oidc_service", description: - "Get OIDC Auth Request details and create callback URLs.\n"+ - "\n"+ + "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"), @@ -565,8 +558,8 @@ module.exports = { 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 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"), @@ -577,7 +570,7 @@ module.exports = { collapsed: true, items: ["apis/assets/assets"], }, - ] + ], }, { type: "category", @@ -617,12 +610,12 @@ module.exports = { "apis/actions/complement-token", "apis/actions/customize-samlresponse", "apis/actions/objects", - ] + ], }, { type: "doc", label: "gRPC Status Codes", - id: "apis/statuscodes" + id: "apis/statuscodes", }, { type: "category", @@ -631,9 +624,9 @@ module.exports = { items: ["apis/observability/metrics", "apis/observability/health"], }, { - type: 'link', - label: 'Rate Limits (Cloud)', // The link label - href: '/legal/policies/rate-limit-policy', // The internal path + type: "link", + label: "Rate Limits (Cloud)", // The link label + href: "/legal/policies/rate-limit-policy", // The internal path }, ], selfHosting: [ @@ -649,7 +642,7 @@ module.exports = { "self-hosting/deploy/knative", "self-hosting/deploy/kubernetes", "self-hosting/deploy/loadbalancing-example/loadbalancing-example", - "self-hosting/deploy/troubleshooting/troubleshooting" + "self-hosting/deploy/troubleshooting/troubleshooting", ], }, { @@ -672,7 +665,7 @@ module.exports = { "self-hosting/manage/reverseproxy/traefik/traefik", "self-hosting/manage/reverseproxy/nginx/nginx", "self-hosting/manage/reverseproxy/caddy/caddy", -// "self-hosting/manage/reverseproxy/httpd/httpd", grpc NOT WORKING + // "self-hosting/manage/reverseproxy/httpd/httpd", grpc NOT WORKING "self-hosting/manage/reverseproxy/cloudflare/cloudflare", "self-hosting/manage/reverseproxy/cloudflare_tunnel/cloudflare_tunnel", "self-hosting/manage/reverseproxy/zitadel_cloud/zitadel_cloud", @@ -683,7 +676,7 @@ module.exports = { "self-hosting/manage/tls_modes", "self-hosting/manage/database/database", "self-hosting/manage/updating_scaling", - "self-hosting/manage/usage_control" + "self-hosting/manage/usage_control", ], }, ], @@ -712,13 +705,14 @@ module.exports = { type: "generated-index", title: "Service description", slug: "/legal/service-description", - description: "Description of services and service levels for ZITADEL Cloud and Enterprise subscriptions.", + description: + "Description of services and service levels for ZITADEL Cloud and Enterprise subscriptions.", }, items: [ { - type: 'autogenerated', - dirName: 'legal/service-description', - } + type: "autogenerated", + dirName: "legal/service-description", + }, ], }, { @@ -729,16 +723,17 @@ module.exports = { type: "generated-index", title: "Policies", slug: "/legal/policies", - description: "Policies and guidelines in addition to our terms of services.", + description: + "Policies and guidelines in addition to our terms of services.", }, items: [ { - type: 'autogenerated', - dirName: 'legal/policies', - } - ] + type: "autogenerated", + dirName: "legal/policies", + }, + ], }, - ] + ], }, ], };