mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-12 06:57:33 +00:00
docs(integrate): improve service user authentication (#7492)
* service users * wip * wip * wip * lower case titles * wip * wip * private key jwt * wip * wip * token introspection * zitadel apis * expiration * replace mermaid with svg * Apply suggestions from code review Co-authored-by: Fabi <fabienne@zitadel.com> * Apply suggestions from code review * boulevard of broken links * my hrefs will go on * docs: add token type to client credential * Update docs/docs/apis/introduction.mdx Co-authored-by: Florian Forster <florian@zitadel.com> * Update docs/docs/guides/integrate/service-users/authenticate-service-users.md Co-authored-by: Florian Forster <florian@zitadel.com> * Update docs/docs/guides/integrate/service-users/authenticate-service-users.md Co-authored-by: Florian Forster <florian@zitadel.com> * Update docs/docs/guides/integrate/service-users/authenticate-service-users.md Co-authored-by: Florian Forster <florian@zitadel.com> * Update docs/docs/guides/integrate/zitadel-apis/access-zitadel-apis.md Co-authored-by: Florian Forster <florian@zitadel.com> * Update docs/docs/guides/integrate/zitadel-apis/access-zitadel-apis.md Co-authored-by: Florian Forster <florian@zitadel.com> * Update docs/docs/guides/integrate/zitadel-apis/access-zitadel-apis.md Co-authored-by: Florian Forster <florian@zitadel.com> * Update docs/docs/guides/integrate/zitadel-apis/access-zitadel-apis.md Co-authored-by: Florian Forster <florian@zitadel.com> * Update docs/docs/guides/integrate/zitadel-apis/access-zitadel-apis.md Co-authored-by: Florian Forster <florian@zitadel.com> * Update docs/docs/guides/integrate/service-users/private-key-jwt.md Co-authored-by: Florian Forster <florian@zitadel.com> * Update docs/docs/guides/integrate/service-users/private-key-jwt.md Co-authored-by: Florian Forster <florian@zitadel.com> * Update docs/docs/guides/integrate/service-users/authenticate-service-users.md Co-authored-by: Florian Forster <florian@zitadel.com> * Update docs/docs/guides/integrate/service-users/client-credentials.md Co-authored-by: Florian Forster <florian@zitadel.com> * Update docs/docs/guides/integrate/zitadel-apis/access-zitadel-apis.md Co-authored-by: Florian Forster <florian@zitadel.com> * Update docs/docs/guides/integrate/service-users/client-credentials.md Co-authored-by: Florian Forster <florian@zitadel.com> * Update docs/docs/guides/integrate/zitadel-apis/_accessing_zitadel_api.md Co-authored-by: Florian Forster <florian@zitadel.com> * Update docs/docs/guides/integrate/zitadel-apis/access-zitadel-apis.md Co-authored-by: Florian Forster <florian@zitadel.com> * Update docs/docs/guides/integrate/zitadel-apis/access-zitadel-apis.md Co-authored-by: Florian Forster <florian@zitadel.com> * Update docs/docs/guides/integrate/zitadel-apis/access-zitadel-apis.md Co-authored-by: Florian Forster <florian@zitadel.com> * Update docs/docs/guides/integrate/zitadel-apis/access-zitadel-apis.md Co-authored-by: Florian Forster <florian@zitadel.com> * Update docs/docs/guides/integrate/zitadel-apis/access-zitadel-apis.md Co-authored-by: Florian Forster <florian@zitadel.com> * Update docs/docs/guides/integrate/zitadel-apis/access-zitadel-apis.md Co-authored-by: Florian Forster <florian@zitadel.com> * Update docs/docs/guides/integrate/zitadel-apis/access-zitadel-apis.md Co-authored-by: Florian Forster <florian@zitadel.com> * Update docs/docs/guides/integrate/zitadel-apis/access-zitadel-apis.md Co-authored-by: Florian Forster <florian@zitadel.com> * docs: add token type to client credential --------- Co-authored-by: Fabi <fabienne@zitadel.com> Co-authored-by: Fabienne <fabienne.gerschwiler@gmail.com> Co-authored-by: Florian Forster <florian@zitadel.com> Co-authored-by: Livio Spring <livio.a@gmail.com>
This commit is contained in:
mffap
@@ -205,10 +205,10 @@ module.exports = {
|
||||
label: "Login Users",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Integrate",
|
||||
title: "Login users with ZITADEL",
|
||||
slug: "guides/integrate/login",
|
||||
description:
|
||||
"Integrate your users and application with ZITADEL. In this section you will find resource on how to authenticate your users, configure external identity providers, access the ZITADEL APIs to manage resources, and integrate with third party services and tools.",
|
||||
"Sign-in users and application with ZITADEL. In this section you will find resources on how to authenticate your users by using the hosted login via OpenID Connect and SAML. Follow our dedicated guides to build your custom login user interface, if you want to customize the login behavior further.",
|
||||
},
|
||||
items: [
|
||||
"guides/integrate/login/login-users",
|
||||
@@ -270,34 +270,27 @@ module.exports = {
|
||||
{
|
||||
type: "category",
|
||||
label: "Token Introspection",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Token Introspection",
|
||||
slug: "/guides/integrate/token-introspection",
|
||||
description:
|
||||
"Token introspection is the process of checking whether an access token is valid and can be used to access protected resources. You have an API that acts as an OAuth resource server and can be accessed by user-facing applications. To validate an access token by calling the ZITADEL introspection API, you can use the JSON Web Token (JWT) Profile (recommended) or Basic Authentication for token introspection. It's crucial to understand that the API is entirely separate from the front end. The API shouldn’t concern itself with the token type received. Instead, it's about how the API chooses to call the introspection endpoint, either through JWT Profile or Basic Authentication. Many APIs assume they might receive a JWT and attempt to verify it based on signature or expiration. However, with ZITADEL, you can send either a JWT or an opaque Bearer token from the client end to the API. This flexibility is one of ZITADEL's standout features.",
|
||||
},
|
||||
collapsed: true,
|
||||
items: [
|
||||
"guides/integrate/token-introspection/private-key-jwt",
|
||||
"guides/integrate/token-introspection/basic-auth",
|
||||
{
|
||||
type: "autogenerated",
|
||||
dirName: "guides/integrate/token-introspection",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Authenticate Service Users",
|
||||
label: "Service Users",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Authenticate ZITADEL Service Users",
|
||||
slug: "/guides/integrate/serviceusers",
|
||||
description:
|
||||
"How to authenticate service users for machine-to-machine (M2M) communication between services. You also need to authenticate service users to access ZITADEL's APIs.",
|
||||
type: "doc",
|
||||
id: "guides/integrate/service-users/authenticate-service-users"
|
||||
},
|
||||
collapsed: true,
|
||||
items: [
|
||||
"guides/integrate/private-key-jwt",
|
||||
"guides/integrate/client-credentials",
|
||||
"guides/integrate/pat",
|
||||
{
|
||||
type: "autogenerated",
|
||||
dirName: "guides/integrate/service-users",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
@@ -362,25 +355,16 @@ module.exports = {
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Access ZITADEL APIs",
|
||||
label: "ZITADEL APIs",
|
||||
link: {
|
||||
type: "doc",
|
||||
id: "guides/integrate/zitadel-apis/access-zitadel-apis"
|
||||
},
|
||||
collapsed: true,
|
||||
items: [
|
||||
{
|
||||
type: "link",
|
||||
label: "Authenticate Service Users",
|
||||
href: "/guides/integrate/serviceusers",
|
||||
},
|
||||
"guides/integrate/access-zitadel-apis",
|
||||
"guides/integrate/access-zitadel-system-api",
|
||||
"guides/integrate/event-api",
|
||||
{
|
||||
type: "category",
|
||||
label: "Example Code",
|
||||
items: [
|
||||
"examples/call-zitadel-api/go",
|
||||
"examples/call-zitadel-api/dot-net",
|
||||
],
|
||||
collapsed: true,
|
||||
type: "autogenerated",
|
||||
dirName: "guides/integrate/zitadel-apis",
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -540,11 +524,6 @@ module.exports = {
|
||||
items: [
|
||||
"support/software-release-cycles-support",
|
||||
"support/troubleshooting",
|
||||
{
|
||||
type: "link",
|
||||
label: "Support Service Descriptions",
|
||||
href: "/legal/service-description/support-services",
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Technical Advisory",
|
||||
|
||||
Reference in New Issue
Block a user