mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-22 04:48:46 +00:00
chore(docs): User (Human) naming consistency (#11512)
# Which Problems Are Solved Naming inconsistencies - User (Human) # How the Problems Are Solved Most of the occurrences have not been changed. `User (Human)` was mostly changed when talking about code objects and where I felt it was necessary to distinguish them from machine users. When both human and machine user occurrences were found, the machine user has been changed to service account (see https://github.com/zitadel/zitadel/issues/11285) # Additional Context - Closes #11284 --------- Co-authored-by: Wim Van Laer <[email protected]>
This commit is contained in:
@@ -24,7 +24,7 @@ In this case please enable the Feature Flag "Use V2 Api in Management Console fo
|
||||
<Tab value="human_deprecated" label="Human User [deprecated]">
|
||||
<img src="/docs/img/guides/console/addhuman.png" width="680px" alt="Add Human" />
|
||||
|
||||
After a human user is created, by default, an initialization mail with a code is sent to the registered email. This code then has to be verified on first login.
|
||||
After a user is created, by default, an initialization mail with a code is sent to the registered email. This code then has to be verified on first login.
|
||||
If you want to omit this mail, you can check the **email verified** and **set initial password** toggle.
|
||||
If no password is set initially, the initialization mail prompting the user to set his password is sent.
|
||||
|
||||
|
||||
@@ -66,7 +66,7 @@ When no specific organization is selected (e.g., during an auth request or via [
|
||||
|
||||
## Usernames and Domains
|
||||
|
||||
Each organization has its own pool of users, covering both human and service users. How these users authenticate depends on your domain configuration.
|
||||
Each organization has its own pool of users, covering both users and service accounts. How these users authenticate depends on your domain configuration.
|
||||
|
||||
### Login Name Formats
|
||||
By default, if the setting **User Loginname must contain orgdomain** is **disabled**, usernames are unique across the entire instance.
|
||||
|
||||
@@ -8,22 +8,22 @@ import CreateUser from './_create-user.mdx';
|
||||
|
||||
## Overview
|
||||
|
||||
ZITADEL supports authentication and authorization for different user types. We mainly differentiate between **Human Users** (interactive) and **Service Users** (machine-to-machine).
|
||||
ZITADEL supports authentication and authorization for different user types. We mainly differentiate between **users** (interactive) and **Service Accounts** (machine-to-machine).
|
||||
|
||||
<img src="/docs/img/guides/console/usersmenu.png" width="420px" alt="User types" />
|
||||
|
||||
## Types of Users
|
||||
|
||||
### Human Users
|
||||
Human users represent actual people who log in via an interactive interface (e.g., a login page).
|
||||
### Users (Human)
|
||||
Users represent actual people who log in via an interactive interface (e.g., a login page).
|
||||
* **Profile:** Has an email address, password, and optional profile data (phone, nickname, gender, language).
|
||||
* **Authentication:** Can authenticate via password, multiple factors (MFA), or passwordless authentication (Passkeys).
|
||||
* **Flow:** The application redirects the user to ZITADEL, which handles the credentials and issues a token to the application.
|
||||
|
||||
Read more on how to [login users with ZITADEL](/guides/integrate/login/login-users).
|
||||
|
||||
### Service Users (Machine Accounts)
|
||||
Service users represent machines, backend services, or IoT devices requiring non-interactive access.
|
||||
### Service Accounts
|
||||
Service accounts represent machines, backend services, or IoT devices requiring non-interactive access.
|
||||
* **Profile:** Only has a name, description, and username.
|
||||
* **Authentication:** Authenticates via **JWT Profile** or **Personal Access Tokens (PAT)**. Both methods support expiration settings.
|
||||
* **Usage:** Primarily used to gain access to the ZITADEL Management API or to secure backend-to-backend communication.
|
||||
@@ -40,7 +40,7 @@ In a multi-tenancy architecture, users are typically isolated within [Organizati
|
||||
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 Human or Service User—can be assigned an [Administrator Role](/concepts/structure/managers).
|
||||
Any user—whether User or Service Account—can be assigned an [Administrator Role](/concepts/structure/managers).
|
||||
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
|
||||
|
||||
@@ -12,14 +12,14 @@ ZITADEL differs two different types of users:
|
||||
|
||||
<img src="/docs/img/guides/console/usersmenu.png" width="420px" alt="User types" />
|
||||
|
||||
A human user has an email address and a password, and can additionally save information about phone, nickname, gender, language.
|
||||
A service user only has a name and a description aside his username.
|
||||
A user has an email address and a password, and can additionally save information about phone, nickname, gender, language.
|
||||
A service account only has a name and a description aside his username.
|
||||
|
||||
A service user can be authenticated with JWT profile or Personal Access Tokens. Both methods can specify an expiry.
|
||||
A human user can authenticate itself with his password, add multiple factors for additional security, and enable passkey authentication.
|
||||
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 users can also be ZITADEL managers is used to restrict access to specific projects or organizations.
|
||||
To get an understanding on how service users are used, take a look at our NextJS B2B Demo application.
|
||||
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.
|
||||
To get an understanding on how service accounts are used, take a look at our NextJS B2B Demo application.
|
||||
|
||||
## Create User
|
||||
|
||||
|
||||
Reference in New Issue
Block a user