mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-19 11:45:12 +00:00
chore: rename manager/member to administrator (#11542)
# Which Problems Are Solved As part of the naming consistency initiative, the terms `Manager`, `Member` and other similar terms that are used in the context of an administrator are replaced by `Administrator` in the UI and documentation. # How the Problems Are Solved By replacing the following terms with Administrator / Administrator Roles in docs, Console UI, and guides. - Manager - Add Manager - Add a Manager - Administrator (used as a person type) - Membership - Member grants # Additional Changes minor grammatical edits in the docs # Additional Context - Closes https://github.com/zitadel/zitadel/issues/11291 --------- Co-authored-by: Marco A. <[email protected]>
This commit is contained in:
co-authored by
Marco A.
parent
319c466476
commit
cc7a6145f1
@@ -0,0 +1,6 @@
|
||||
When adding a new administrator, you can select multiple roles, some of which are only allowed to read data.
|
||||
This can be especially useful if you add service users for one of your projects where you only need read access.
|
||||
|
||||
By default, you will only search for users within the selected organization. If you like to give a role to a user outside the organization, you need to switch to the global search and type the exact loginname of the users. This will prevent users from guessing users from other organizations.
|
||||
|
||||
<img alt="Administrators" src="/docs/img/guides/console/add_administrator.png" width="390px" />
|
||||
@@ -1,6 +0,0 @@
|
||||
When adding a new manager, you can select multiple roles some of which are only allowed to read data.
|
||||
This can be especially useful if you add service users for one of your projects where you only need read access.
|
||||
|
||||
Per default you will only search for users within the selected organization. If you like to give a role to a user outside the organization you need to switch to the global search and type the exact loginname of the users. This will prevent users from guessing users from other organizations.
|
||||
|
||||
<img alt="Managers" src="/docs/img/guides/console/addmanager.png" width="390px" />
|
||||
+11
-11
@@ -1,21 +1,21 @@
|
||||
---
|
||||
title: ZITADEL Managers
|
||||
sidebar_label: Managers
|
||||
title: ZITADEL Administrators
|
||||
sidebar_label: Administrators
|
||||
---
|
||||
|
||||
import ManagerDescription from "../../../concepts/structure/_manager_description.mdx";
|
||||
import AddManager from "./_add_manager.mdx";
|
||||
import AdministratorDescription from "../../../concepts/structure/_administrator_description.mdx";
|
||||
import AddAdministrator from "./_add_administrator.mdx";
|
||||
import PermissionTable from '@/components/PermissionTable';
|
||||
import permissionData from "../../../../../../cmd/defaults.yaml";
|
||||
|
||||
<ManagerDescription components={props.components} name="ManagerDescription" />
|
||||
<AdministratorDescription components={props.components} name="AdministratorDescription" />
|
||||
|
||||
To configure managers in ZITADEL go to the resource where you like to add it (e.g Instance, Organization, Project, GrantedProject).
|
||||
In the right part of the management console you can find **MANAGERS** in the details part. Here you have a list of the current managers and can add a new one.
|
||||
To configure administrators in ZITADEL, go to the resource where you like to add it (e.g., Instance, Organization, Project, GrantedProject).
|
||||
In the right part of the management console you can find **ADMINISTRATORS** in the details part. Here you have a list of the current administrators and can add a new one.
|
||||
|
||||
<img alt="Managers" src="/docs/img/guides/console/managers.png" width="200px" />
|
||||
<img alt="Administrators" src="/docs/img/guides/console/administrators.png" width="200px" />
|
||||
|
||||
<AddManager components={props.components} name="AddManager" />
|
||||
<AddAdministrator components={props.components} name="AddAdministrator" />
|
||||
|
||||
## Roles
|
||||
|
||||
@@ -44,7 +44,7 @@ In the right part of the management console you can find **MANAGERS** in the det
|
||||
|
||||
## Configure roles
|
||||
|
||||
If you run a self hosted ZITADEL instance you can define your custom roles by overwriting the defaults.yaml
|
||||
If you run a self-hosted ZITADEL instance, you can define your custom roles by overwriting the defaults.yaml
|
||||
In the InternalAuthZ section you will find all the roles and which permissions they have.
|
||||
|
||||
Example:
|
||||
@@ -58,7 +58,7 @@ InternalAuthZ:
|
||||
- "iam.write"
|
||||
```
|
||||
|
||||
# Manager Permission Matrix
|
||||
# Administrator Permission Matrix
|
||||
|
||||
This table is generated dynamically from our configuration file.
|
||||
|
||||
@@ -181,7 +181,7 @@ If your application makes requests from domains other than the Redirect URI (e.g
|
||||
|
||||
Ensure the configuration of application settings is limited to authorized users only.
|
||||
|
||||
* Use [Administrator roles](./managers) to limit permissions for your users to make changes to your applications.
|
||||
* Use [Administrator roles](./administrators) to limit permissions for your users to make changes to your applications.
|
||||
* When [granting projects](../../../concepts/structure/granted_projects) to other organizations, the receiving organization **cannot** see or change the application configuration. They can only assign roles.
|
||||
|
||||
## References
|
||||
|
||||
@@ -5,7 +5,7 @@ sidebar_label: Management Console
|
||||
|
||||
## Overview
|
||||
|
||||
The ZITADEL Management Console is the web-based Dashboard UI designed to facilitate the management and administration of ZITADEL resources and configurations. It serves as a central hub where [Managers](/concepts/structure/managers) can perform tasks related to identity and access management, configure authentication methods, and manage the organization's infrastructure.
|
||||
The ZITADEL Management Console is the web-based Dashboard UI designed to facilitate the management and administration of ZITADEL resources and configurations. It serves as a central hub where [Administrators](/concepts/structure/administrators) can perform tasks related to identity and access management, configure authentication methods, and manage the organization's infrastructure.
|
||||
|
||||
While the Management Console is primarily a tool for administrators, it can also be accessed by end-users to manage their own profiles (e.g., password reset, MFA setup), unless you [restrict access](/guides/solution-scenarios/restrict-console) to build your own custom UI.
|
||||
|
||||
@@ -36,7 +36,7 @@ To understand how to structure your organizations, read our [Solution Scenario](
|
||||
|
||||
The Management Console enables administrators to perform the following critical tasks:
|
||||
|
||||
1. **Default Settings:** Managers can configure global system defaults. This includes authentication methods, security policies (like password complexity or lockout policies), and other system-wide parameters.
|
||||
1. **Default Settings:** Administrators can configure global system defaults. This includes authentication methods, security policies (like password complexity or lockout policies), and other system-wide parameters.
|
||||
2. **Resource Management:** Create, update, and delete essential resources such as [Organizations](./organizations-overview), [Projects](./projects-overview), and [Applications](./applications-overview).
|
||||
3. **User Management:** Manage the lifecycle of [User accounts](./users-overview). This includes creating new users, updating profiles, resetting passwords, and deactivating accounts.
|
||||
4. **Access Control:** Define and manage permissions. Administrators can assign [Roles](/guides/manage/console/roles) to users and configure fine-grained access controls for specific resources.
|
||||
@@ -54,4 +54,4 @@ Please follow the [Restrict Management Console Access guide](/guides/solution-sc
|
||||
|
||||
## References
|
||||
|
||||
* [Administrator Roles Concept](/concepts/structure/managers)
|
||||
* [Administrator Roles Concept](/concepts/structure/administrators)
|
||||
|
||||
@@ -3,11 +3,11 @@ title: ZITADEL Management Console
|
||||
sidebar_label: Overview
|
||||
---
|
||||
|
||||
## What is management console?
|
||||
## What is the management console?
|
||||
|
||||
Management Console is the Dashboard UI for your instance. It can be accessed from all configured Custom Domains, defined in the Customer Portal.
|
||||
The management console is used to configure global default settings and can be used by multiple Managers.
|
||||
Read more about [Console Managers](./managers) here.
|
||||
The management console is used to configure global default settings and can be used by multiple Administrators.
|
||||
Read more about [Console Administrators](./administrators) here.
|
||||
|
||||
It can also be used by your application users to modify their profile, although we recommend that you build your own User Interface.
|
||||
|
||||
|
||||
@@ -39,8 +39,8 @@ Federated users are identities managed by a third-party Identity Provider (IdP)
|
||||
In a multi-tenancy architecture, users are typically isolated within [Organizations](./organizations-overview).
|
||||
However, using [External User Grants](../../../concepts/features/external-user-grant), an organization can invite users from *another* organization to access their projects. These invited users are referred to as **External Users** within the context of the inviting organization.
|
||||
|
||||
### Managers
|
||||
Any user—whether User or Service Account—can be assigned an [Administrator Role](/concepts/structure/managers).
|
||||
### Administrators
|
||||
Any user—whether User or Service Account—can be assigned an [Administrator Role](/concepts/structure/administrators).
|
||||
A user with an administrator role is not just an end-user of your application but also has permissions to manage specific aspects of the ZITADEL instance, organization, or project (e.g., `ORG_OWNER`, `PROJECT_OWNER`).
|
||||
|
||||
## Considerations
|
||||
|
||||
@@ -18,7 +18,7 @@ A service account only has a name and a description aside his username.
|
||||
A service account can be authenticated with JWT profile or Personal Access Tokens. Both methods can specify an expiry.
|
||||
A user can authenticate itself with his password, add multiple factors for additional security, and enable passkey authentication.
|
||||
|
||||
Service users are primarily used to gain access for a backend service or iot device. The fact that service accounts can also be ZITADEL managers is used to restrict access to specific projects or organizations.
|
||||
Service users are primarily used to gain access for a backend service or iot device. The fact that service accounts can also be ZITADEL administrators is used to restrict access to specific projects or organizations.
|
||||
To get an understanding on how service accounts are used, take a look at our NextJS B2B Demo application.
|
||||
|
||||
## Create User
|
||||
@@ -39,10 +39,10 @@ Just navigate to the section **Metadata** and click on **edit**.
|
||||
alt="User Metadata"
|
||||
/>
|
||||
|
||||
Metadata can requested via our auth and management APIs, from userinfo endpoint or ID Token.
|
||||
Metadata can be requested via our auth and management APIs, from userinfo endpoint or ID Token.
|
||||
To get your metadata from the userinfo endpoint, add `urn:zitadel:iam:user:metadata` to your authentication request. Take a look at our reserved scopes [here](/apis/openidoauth/scopes#reserved-scopes) or take a look at our [metadata guide](../customize/user-metadata).
|
||||
|
||||
You can then toggle **User Info inside ID Token** in your application settings, if you need this information in the ID Token too.
|
||||
You can then toggle **User Info inside ID Token** in your application settings if you need this information in the ID Token too.
|
||||
|
||||
<img
|
||||
src="/docs/img/guides/console/appidtokensettings.png"
|
||||
|
||||
Reference in New Issue
Block a user