mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-21 04:18:46 +00:00
docs: migrate to native Fumadocs search & UI fixes (#12732)
Changes: - **Search**: Replaced Inkeep with Fumadocs' native built-in search (createFromSource). Removed @inkeep/cxkit-react and custom search dialogs. - **Hydration Fix**: Removed markdown links from ### headings in egress.mdx (across all versions) to fix the <a inside a> DOM mismatch error. - **Console Fix**: Added the missing key prop to <VersionSelector/> in the layout to resolve the React list warning. --------- Co-authored-by: Florian Forster <[email protected]> Co-authored-by: Claude Fable 5.1 <[email protected]>
This commit is contained in:
co-authored by
Florian Forster
Claude Fable 5.1
parent
7e34f04361
commit
8ccd5b206f
@@ -222,9 +222,9 @@ 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 setup. You can use the logged-in user’s token or the service account’s token to retrieve the roles assigned to this user using the [APIs listed under user authorizations/grants in the auth API](/reference/api/authorization/zitadel.authorization.v2.AuthorizationService.ListAuthorizations).
|
||||
**Scope used:** `openid urn:zitadel:iam:org:project:id:zitadel:aud`
|
||||
|
||||
#### **1. [List my project roles](/reference/api/auth/zitadel.auth.v1.AuthService.ListMyProjectPermissions)**
|
||||
#### **1. List my project roles**
|
||||
|
||||
Returns a list of roles for the authenticated user and for the requesting project (based on the token).
|
||||
Returns a list of roles for the authenticated user and for the requesting project (based on the token). See the [ListMyProjectPermissions](/reference/api/auth/zitadel.auth.v1.AuthService.ListMyProjectPermissions) API reference.
|
||||
|
||||
**URL: https://`${CUSTOM_DOMAIN}`/auth/v1/permissions/me/_search**
|
||||
|
||||
@@ -245,9 +245,9 @@ curl -L -X POST 'https://${CUSTOM_DOMAIN}/auth/v1/permissions/me/_search' \
|
||||
}
|
||||
```
|
||||
|
||||
#### **2.[List my ZITADEL permissions](/reference/api/auth/zitadel.auth.v1.AuthService.ListMyZitadelPermissions)**
|
||||
#### **2. List my ZITADEL permissions**
|
||||
|
||||
Returns a list of permissions the authenticated user has in ZITADEL based on the administrator roles the user has. (e.g: `ORG_OWNER` = `org.read`, `org.write`, ...).
|
||||
Returns a list of permissions the authenticated user has in ZITADEL based on the administrator roles the user has. (e.g: `ORG_OWNER` = `org.read`, `org.write`, ...). See the [ListMyZitadelPermissions](/reference/api/auth/zitadel.auth.v1.AuthService.ListMyZitadelPermissions) API reference.
|
||||
|
||||
This request can be used if you are building a management UI. For instance, if the UI is managing users, you can show the management functionality based on the permissions the user has. Here’s an example: if the user has `user.read` and `user.write` permission you can show the edit buttons, if the user only has `user.read` permission, you can hide the edit buttons.
|
||||
|
||||
@@ -293,9 +293,9 @@ curl -L -X POST 'https://${CUSTOM_DOMAIN}/auth/v1/permissions/zitadel/me/_search
|
||||
}
|
||||
```
|
||||
|
||||
#### **[3. List my role assignments](/reference/api/auth/zitadel.auth.v1.AuthService.ListMyUserGrants)**
|
||||
#### **3. List my role assignments**
|
||||
|
||||
Returns a list of roles the authenticated user has been assigned. Role assignments (referred to as user grants in the APIs) consist of an organization, a project, and roles.
|
||||
Returns a list of roles the authenticated user has been assigned. Role assignments (referred to as user grants in the APIs) consist of an organization, a project, and roles. See the [ListMyUserGrants](/reference/api/auth/zitadel.auth.v1.AuthService.ListMyUserGrants) API reference.
|
||||
|
||||
**URL: https://`${CUSTOM-DOMAIN}`/auth/v1/usergrants/me/_search**
|
||||
|
||||
@@ -405,9 +405,9 @@ In [APIs listed under user grants in the management API](/reference/api/manageme
|
||||
|
||||
**Scope used:** `openid urn:zitadel:iam:org:project:id:zitadel:aud`
|
||||
|
||||
#### **1. [Search user grants](/reference/api/management/zitadel.management.v1.ManagementService.ListUserGrants)**
|
||||
#### **1. Search user grants**
|
||||
|
||||
Returns a list of user roles that match the search queries. A user with administrator permissions will call this API and will also have to reside in the same organization as the user.
|
||||
Returns a list of user roles that match the search queries. A user with administrator permissions will call this API and will also have to reside in the same organization as the user. See the [ListUserGrants](/reference/api/management/zitadel.management.v1.ManagementService.ListUserGrants) API reference.
|
||||
|
||||
**URL: https://`${CUSTOM_DOMAIN}`/management/v1/users/grants/_search**
|
||||
|
||||
@@ -474,9 +474,9 @@ curl -L -X POST 'https://${CUSTOM_DOMAIN}/management/v1/users/grants/_search' \
|
||||
}
|
||||
```
|
||||
|
||||
#### **2. [User grant by ID](/reference/api/management/zitadel.management.v1.ManagementService.GetUserGrantByID)**
|
||||
#### **2. User grant by ID**
|
||||
|
||||
Returns a user grant per ID. A user grant is a role a user has for a specific project and organization.
|
||||
Returns a user grant per ID. A user grant is a role a user has for a specific project and organization. See the [GetUserGrantByID](/reference/api/management/zitadel.management.v1.ManagementService.GetUserGrantByID) API reference.
|
||||
|
||||
**URL: https://`${CUSTOM_DOMAIN}`/management/v1/users/:userId/grants/:grantId**
|
||||
|
||||
|
||||
@@ -12,8 +12,8 @@ This page lists the static Egress (outgoing) IP addresses used by ZITADEL Cloud
|
||||
|
||||
You need to allowlist these IP addresses if you use features where ZITADEL initiates a connection to your systems. This is commonly required for the following scenarios:
|
||||
|
||||
### [Identity Providers & Federation](/guides/integrate/identity-providers/introduction)
|
||||
If you are federating an external Identity Provider (IdP) that sits behind a firewall:
|
||||
### Identity Providers & Federation
|
||||
If you are federating an [external Identity Provider (IdP)](/guides/integrate/identity-providers/introduction) that sits behind a firewall:
|
||||
* **LDAP / Active Directory:** When ZITADEL connects to your LDAP server (typically port `636` for LDAPS).
|
||||
* **OIDC / OAuth:** When ZITADEL connects to your IdP for:
|
||||
* **Discovery:** Fetching configuration from `/.well-known/openid-configuration`.
|
||||
@@ -22,7 +22,8 @@ If you are federating an external Identity Provider (IdP) that sits behind a fir
|
||||
* **Keys:** Fetching signing keys from the `jwks_uri`.
|
||||
* **SAML:** If ZITADEL needs to fetch the `metadata.xml` or artifact resolution services from an internal SAML IdP.
|
||||
|
||||
### [Notification Providers](/guides/manage/customize/notification-providers)
|
||||
### Notification Providers
|
||||
For custom [Notification Providers](/guides/manage/customize/notification-providers):
|
||||
* [**SMTP:**](/guides/manage/customize/notification-providers#smtp-providers) If you configured a custom SMTP sender pointing to your own mail server.
|
||||
* [**Webhook / HTTP provider:**](/guides/manage/customize/notification-providers#webhook-http-provider) If you use a custom gateway for SMS or Emails.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user