diff --git a/docs/docs/concepts/features/audit-trail.md b/docs/docs/concepts/features/audit-trail.md index 7e7fc104f..892cc1f44 100644 --- a/docs/docs/concepts/features/audit-trail.md +++ b/docs/docs/concepts/features/audit-trail.md @@ -45,7 +45,7 @@ Go to your default settings and then click on the Tab **Events** to open the Eve Since everything that is available in Console can also be called with our APIs, you can access all events and audit data trough our APIs: - [Event API Guide](/docs/guides/integrate/zitadel-apis/event-api) -- [API Documentation](/docs/apis/resources/admin/events) +- [API Documentation](/docs/category/apis/resources/admin/events) Access to the API is possible with a [Service User](/docs/guides/integrate/service-users/authenticate-service-users) account, allowing you to integrate the events with your own business logic. diff --git a/docs/docs/concepts/features/external-user-grant.md b/docs/docs/concepts/features/external-user-grant.md index 0bb79476c..cb72f5054 100644 --- a/docs/docs/concepts/features/external-user-grant.md +++ b/docs/docs/concepts/features/external-user-grant.md @@ -35,6 +35,6 @@ In some use cases, external user grants are a simple way to allow users access t ## References -* [API reference for user grants](/docs/apis/resources/mgmt/user-grants) +* [API reference for user grants](/docs/category/apis/resources/mgmt/user-grants) * [How to manage user grants through ZITADEL's console](/docs/guides/manage/console/roles#authorizations) * [More about multi-tenancy with ZITADEL](https://zitadel.com/blog/multi-tenancy-with-organizations) diff --git a/docs/docs/concepts/features/identity-brokering.md b/docs/docs/concepts/features/identity-brokering.md index 17be4f6e8..d1fb624c7 100644 --- a/docs/docs/concepts/features/identity-brokering.md +++ b/docs/docs/concepts/features/identity-brokering.md @@ -75,4 +75,4 @@ To address this, ZITADEL provides generic templates that enable connection to vi * [Detailed integration guide for many identity providers](/guides/integrate/identity-providers/introduction) * [Setup identity providers with Console](/guides/manage/console/default-settings#identity-providers) -* [Configure identity providers with the ZITADEL API](/docs/apis/resources/mgmt/identity-providers) +* [Configure identity providers with the ZITADEL API](/docs/category/apis/resources/mgmt/identity-providers) diff --git a/docs/docs/concepts/structure/applications.md b/docs/docs/concepts/structure/applications.md index cd5634dfc..22fe81787 100644 --- a/docs/docs/concepts/structure/applications.md +++ b/docs/docs/concepts/structure/applications.md @@ -25,4 +25,4 @@ Ensure the configuration of application settings is limited to authorized users ## References - [Configure Applications in the Console](../../guides/manage/console/applications-overview) -- [ZITADEL API: Applications](/docs/apis/resources/mgmt/applications) +- [ZITADEL API: Applications](/docs/category/apis/resources/mgmt/applications) diff --git a/docs/docs/concepts/structure/users.md b/docs/docs/concepts/structure/users.md index 911b54602..8d512d744 100644 --- a/docs/docs/concepts/structure/users.md +++ b/docs/docs/concepts/structure/users.md @@ -78,5 +78,5 @@ You can use organization metadata or your own business logic to describe a hiera ## References - [Manage users in the Console](../../guides/manage/console/users-overview) -- [ZITADEL APIs: Users](/docs/apis/resources/mgmt/users) +- [ZITADEL APIs: Users](/docs/category/apis/resources/mgmt/users) - [User onboarding and registration](/docs/guides/integrate/onboarding) diff --git a/docs/docs/guides/integrate/back-channel-logout.mdx b/docs/docs/guides/integrate/back-channel-logout.mdx index 66eb4c2e9..7aa387889 100644 --- a/docs/docs/guides/integrate/back-channel-logout.mdx +++ b/docs/docs/guides/integrate/back-channel-logout.mdx @@ -58,7 +58,7 @@ provides the possibility to match the exact SSO session, which was terminated. ### Client To enable the back-channel logout on a client, they simply need to register a `backchannel_logout_uri` as part of their -configuration, e.g. [creating an OIDC application](https://zitadel.com/docs/apis/resources/mgmt/management-service-add-oidc-app). +configuration, e.g. [creating an OIDC application](https://zitadel.com/docs/category/apis/resources/mgmt/management-service-add-oidc-app). As soon as the URI is set, every new authorization request will register a back-channel notification to be sent once the session is terminated by a user sign out. diff --git a/docs/docs/guides/integrate/identity-providers/introduction.md b/docs/docs/guides/integrate/identity-providers/introduction.md index 6d434a800..8ff38a7fe 100644 --- a/docs/docs/guides/integrate/identity-providers/introduction.md +++ b/docs/docs/guides/integrate/identity-providers/introduction.md @@ -179,5 +179,5 @@ Deciding whether to configure an external Identity Provider (IdP) at the organiz ## References - [Identity brokering in ZITADEL](/docs/concepts/features/identity-brokering) -- [The ZITADEL API reference for managing external IdPs](/docs/apis/resources/admin/identity-providers) +- [The ZITADEL API reference for managing external IdPs](/docs/category/apis/resources/admin/identity-providers) - [Handle external logins in a custom login UI](/docs/guides/integrate/login-ui/external-login) diff --git a/docs/docs/guides/integrate/login/oidc/webkeys.md b/docs/docs/guides/integrate/login/oidc/webkeys.md index 3935368ff..f563aaa52 100644 --- a/docs/docs/guides/integrate/login/oidc/webkeys.md +++ b/docs/docs/guides/integrate/login/oidc/webkeys.md @@ -95,7 +95,7 @@ two web key pairs are created with one activated. ### Creation -The web key [create](/docs/apis/resources/webkey_service_v3/zitadel-web-keys-create-web-key) endpoint generates a new web key pair, +The web key [create](/docs/apis/resources/webkey_service_v2/zitadel-webkey-v-2-web-key-service-create-web-key) endpoint generates a new web key pair, using the passed generator configuration from the request. This config is a one-of field of: - RSA @@ -192,7 +192,7 @@ curl -L 'https://${CUSTOM_DOMAIN}/v2/web_keys' \ ### Activation -When a generated web key is [activated](/docs/apis/resources/webkey_service_v3/zitadel-web-keys-activate-web-key), +When a generated web key is [activated](/docs/apis/resources/webkey_service_v2/zitadel-webkey-v-2-web-key-service-activate-web-key), its private key will be used to sign new tokens. There can be only one active key on an instance. Activating a key implies deactivation of the previously active key. @@ -203,7 +203,7 @@ at least for the duration of the max-age setting plus any time it might take for ### Deletion -Non-active keys may be [deleted](/docs/apis/resources/webkey_service_v3/zitadel-web-keys-delete-web-key). +Non-active keys may be [deleted](/docs/apis/resources/webkey_service_v2/zitadel-webkey-v-2-web-key-service-delete-web-key). Deletion also means tokens signed with this key become invalid. Active keys can't be deleted. As each public key is available on the [JWKS](#json-web-key-set) endpoint, diff --git a/docs/docs/guides/integrate/retrieve-user-roles.md b/docs/docs/guides/integrate/retrieve-user-roles.md index e0c1dd191..e71a462a7 100644 --- a/docs/docs/guides/integrate/retrieve-user-roles.md +++ b/docs/docs/guides/integrate/retrieve-user-roles.md @@ -18,8 +18,8 @@ Follow the links below to assign roles to your users. - [Add application roles via the ZITADEL Console](/docs/guides/manage/console/roles) - [Add manager roles via the ZITADEL Console](/docs/guides/manage/console/managers) -- [Add application roles via the ZITADEL Management API](/docs/apis/resources/mgmt/project-roles) -- [Add manager roles to users via the ZITADEL Management API](/docs/apis/resources/mgmt/members) +- [Add application roles via the ZITADEL Management API](/docs/category/apis/resources/mgmt/project-roles) +- [Add manager roles to users via the ZITADEL Management API](/docs/category/apis/resources/mgmt/members) ## Retrieve roles @@ -218,7 +218,7 @@ https://github.com/zitadel/actions/blob/main/examples/custom_roles.js Now we will use the auth API to retrieve roles from a logged in user using the user’s token The base URL is: **https://`${CUSTOM_DOMAIN}`/auth/v1** -Let’s start with a user who has multiple roles in different organizations in a multi-tenanted set up. You can use the logged in user’s token or the machine user’s token to retrieve the authorizations using the [APIs listed under user authorizations/grants in the auth API](/docs/apis/resources/auth/user-authorizations-grants). +Let’s start with a user who has multiple roles in different organizations in a multi-tenanted set up. You can use the logged in user’s token or the machine user’s token to retrieve the authorizations using the [APIs listed under user authorizations/grants in the auth API](/docs/category/apis/resources/auth/user-authorizations-grants). **Scope used:** `openid urn:zitadel:iam:org:project:id:zitadel:aud` @@ -402,7 +402,7 @@ Now we will use the management API to retrieve user roles under an admin user. The base URL is: **https://`${CUSTOM_DOMAIN}`/management/v1** -In [APIs listed under user grants in the management API](/docs/apis/resources/mgmt/user-grants), you will see that you can use the management API to retrieve and modify user grants. The two API paths that we are interested in to fetch user roles are given below. +In [APIs listed under user grants in the management API](/docs/category/apis/resources/mgmt/user-grants), you will see that you can use the management API to retrieve and modify user grants. The two API paths that we are interested in to fetch user roles are given below. **Scope used:** `openid urn:zitadel:iam:org:project:id:zitadel:aud` diff --git a/docs/docs/guides/integrate/service-users/authenticate-service-users.md b/docs/docs/guides/integrate/service-users/authenticate-service-users.md index 66e962791..7ca961ae2 100644 --- a/docs/docs/guides/integrate/service-users/authenticate-service-users.md +++ b/docs/docs/guides/integrate/service-users/authenticate-service-users.md @@ -127,7 +127,7 @@ However, [client credentials authentication](./client-credentials.md) might be c ## Further resources * Read about the [different methods to authenticate service users](./authenticate-service-users) -* [Service User API reference](/docs/apis/resources/mgmt/user-machine) +* [Service User API reference](/docs/category/apis/resources/mgmt/user-machine) * [OIDC JWT with private key](/docs/apis/openidoauth/authn-methods#jwt-with-private-key) authentication method reference * [Access ZITADEL APIs](../zitadel-apis/access-zitadel-apis) * Validate access tokens with [token introspection with private key jwt](../token-introspection/private-key-jwt.mdx) diff --git a/docs/docs/guides/integrate/service-users/client-credentials.md b/docs/docs/guides/integrate/service-users/client-credentials.md index b3be8383a..f18547b96 100644 --- a/docs/docs/guides/integrate/service-users/client-credentials.md +++ b/docs/docs/guides/integrate/service-users/client-credentials.md @@ -103,7 +103,7 @@ By following these steps and adhering to security best practices, you can effect ## Notes * Read about the [different methods to authenticate service users](./authenticate-service-users) -* [Service User API reference](/docs/apis/resources/mgmt/user-machine) +* [Service User API reference](/docs/category/apis/resources/mgmt/user-machine) * [OIDC client secret basic](/docs/apis/openidoauth/authn-methods#client-secret-basic) authentication method reference * [Access ZITADEL APIs](../zitadel-apis/access-zitadel-apis) * Validate access tokens with [token introspection with basic auth](../token-introspection/basic-auth) diff --git a/docs/docs/guides/manage/customize/notification-providers.mdx b/docs/docs/guides/manage/customize/notification-providers.mdx index a6e5223da..a33defcb9 100644 --- a/docs/docs/guides/manage/customize/notification-providers.mdx +++ b/docs/docs/guides/manage/customize/notification-providers.mdx @@ -69,7 +69,7 @@ A provider with HTTP type will send the messages and the data to a pre-defined w The `id` is the provider's ID from the previous step. - See full API reference for [SMS Providers](/apis/resources/admin/sms-provider) for more details. + See full API reference for [SMS Providers](/docs/category/apis/resources/admin/sms-provider) for more details. diff --git a/docs/docs/guides/manage/customize/restrictions.md b/docs/docs/guides/manage/customize/restrictions.md index 660dd2b77..525b3953d 100644 --- a/docs/docs/guides/manage/customize/restrictions.md +++ b/docs/docs/guides/manage/customize/restrictions.md @@ -4,7 +4,7 @@ title: Feature Restrictions New self-hosted and [ZITADEL Cloud instances](https://zitadel.com/signin) are unrestricted by default. Self-hosters can change this default using the DefaultInstance.Restrictions configuration section. -Users with the role IAM_OWNER can change the restrictions of their instance using the [Feature Restrictions Admin API](/apis/resources/admin/feature-restrictions). +Users with the role IAM_OWNER can change the restrictions of their instance using the [Feature Restrictions Admin API](/docs/category/apis/resources/admin/feature-restrictions). Currently, the following restrictions are available: - *Disallow public organization registrations* - If restricted, only users with the role IAM_OWNERS can create new organizations. The endpoint */ui/login/register/org* returns HTTP status 404 on GET requests, and 409 on POST requests. diff --git a/docs/docs/guides/manage/customize/user-metadata.md b/docs/docs/guides/manage/customize/user-metadata.md index a9dbd7c9e..dc5a98f7f 100644 --- a/docs/docs/guides/manage/customize/user-metadata.md +++ b/docs/docs/guides/manage/customize/user-metadata.md @@ -227,4 +227,4 @@ The user that calls the management service must have [manager permissions](/docs A user can be either a human user or a service user. You can get [metadata of a user filtered by your query](/docs/apis/resources/mgmt/management-service-list-user-metadata) or [get a metadata object from a user by a specific key](/docs/apis/resources/mgmt/management-service-get-user-metadata). -The management service allows you to set and delete metadata, see the [API documentation for users](/docs/apis/resources/mgmt/users). +The management service allows you to set and delete metadata, see the [API documentation for users](/docs/category/apis/resources/mgmt/users). diff --git a/docs/docs/guides/migrate/users.md b/docs/docs/guides/migrate/users.md index 52ef77934..5817782c7 100644 --- a/docs/docs/guides/migrate/users.md +++ b/docs/docs/guides/migrate/users.md @@ -238,7 +238,7 @@ Use metadata to store additional attributes of the users, such as organizational :::info Metadata must be added to users after the users were created. Currently metadata can't be added during user creation. -[API reference: User Metadata](/docs/apis/resources/mgmt/user-metadata) +[API reference: User Metadata](/docs/category/apis/resources/mgmt/user-metadata) ::: Request metadata from the userinfo endpoint by passing the required [reserved scope](/docs/apis/openidoauth/scopes#reserved-scopes) in your auth request. @@ -250,5 +250,5 @@ You can assign roles from owned or granted projects to a user. :::info Authorizations must be added to users after the users were created. Currently metadata can't be added during user creation. -[API reference: User Authorization / Grants](/docs/apis/resources/auth/user-authorizations-grants) +[API reference: User Authorization / Grants](/docs/category/apis/resources/auth/user-authorizations-grants) ::: \ No newline at end of file diff --git a/docs/docs/self-hosting/manage/cache.md b/docs/docs/self-hosting/manage/cache.md index 3fb2bfac7..97b83b14b 100644 --- a/docs/docs/self-hosting/manage/cache.md +++ b/docs/docs/self-hosting/manage/cache.md @@ -158,7 +158,7 @@ Caches: ### Instance -All HTTP and gRPC requests sent to ZITADEL receive an instance context. The instance is usually resolved by the domain from the request. In some cases, like the [system service](/docs/apis/resources/system/system-service), the instance can be resolved by its ID. An instance object contains many of the [default settings](/docs/guides/manage/console/default-settings): +All HTTP and gRPC requests sent to ZITADEL receive an instance context. The instance is usually resolved by the domain from the request. In some cases, like the [system service](/docs/category/apis/resources/system/system-service), the instance can be resolved by its ID. An instance object contains many of the [default settings](/docs/guides/manage/console/default-settings): - Instance [features](/docs/guides/manage/console/default-settings#features) - Custom Domains: generated and [custom](/docs/guides/manage/cloud/instances#add-custom-domain) diff --git a/docs/docs/self-hosting/manage/usage_control.md b/docs/docs/self-hosting/manage/usage_control.md index cb5c57f83..4a44c03df 100644 --- a/docs/docs/self-hosting/manage/usage_control.md +++ b/docs/docs/self-hosting/manage/usage_control.md @@ -9,7 +9,7 @@ The usage control features are currently limited to the instance level only. ## Block Instances -You can block an instance using the [system API](/apis/resources/system/limits). +You can block an instance using the [system API](/docs/category/apis/resources/system/limits). Most requests to a blocked instance are rejected with the HTTP status *429 Too Many Requests* or the gRPC status *8 Resource Exhausted*. However, requests to the [system API](/apis/introduction#system) are still allowed. @@ -55,7 +55,7 @@ DefaultInstance: AuditLogRetention: # ZITADEL_DEFAULTINSTANCE_LIMITS_AUDITLOGRETENTION ``` -You can also set a limit for [a specific virtual instance](/concepts/structure/instance#multiple-virtual-instances) using the [system API](/apis/resources/system/limits). +You can also set a limit for [a specific virtual instance](/concepts/structure/instance#multiple-virtual-instances) using the [system API](/docs/category/apis/resources/system/limits). ## Quotas @@ -85,7 +85,7 @@ Quotas: MaxBulkSize: 0 # ZITADEL_QUOTAS_EXECUTION_DEBOUNCE_MAXBULKSIZE ``` -Once you have activated the quotas feature, you can configure quotas [for your virtual instances](/concepts/structure/instance#multiple-virtual-instances) using the [system API](/apis/resources/system/quotas) or the *DefaultInstances.Quotas* section. +Once you have activated the quotas feature, you can configure quotas [for your virtual instances](/concepts/structure/instance#multiple-virtual-instances) using the [system API](/docs/category/apis/resources/system/quotas) or the *DefaultInstances.Quotas* section. The following snippets shows the defaults: ```yaml diff --git a/docs/vercel.json b/docs/vercel.json index 876419c2f..2a5ebb8be 100644 --- a/docs/vercel.json +++ b/docs/vercel.json @@ -24,31 +24,6 @@ "source": "/", "destination": "/docs" }, - { - "source": "/docs/category/apis/:slug*", - "destination": "/docs/apis/:slug*", - "permanent": true - }, - { - "source": "/docs/apis/mgmt/:slug*", - "destination": "/docs/apis/resources/mgmt/:slug*", - "permanent": true - }, - { - "source": "/docs/apis/auth/:slug*", - "destination": "/docs/apis/resources/auth/:slug*", - "permanent": true - }, - { - "source": "/docs/apis/system/:slug*", - "destination": "/docs/apis/resources/system/:slug*", - "permanent": true - }, - { - "source": "/docs/apis/admin/:slug*", - "destination": "/docs/apis/resources/admin/:slug*", - "permanent": true - }, { "source": "/docs/apis/actionsv2/introduction", "destination": "/docs/apis/actions/v2/usage",