mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-17 02:55:11 +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:
@@ -77,7 +77,7 @@ The trigger is represented by the following Ids in the API: `TRIGGER_TYPE_PRE_CR
|
||||
- `ctx`
|
||||
The first parameter contains the following fields
|
||||
- `v1`
|
||||
- `user` [*human*](./objects#human-user)
|
||||
- `user` [*(human)*](./objects#human-user)
|
||||
- `authRequest` [*auth request*](/apis/actions/objects#auth-request)
|
||||
- `httpRequest` [*http request*](/apis/actions/objects#http-request)
|
||||
- `org`
|
||||
|
||||
@@ -63,8 +63,8 @@ title: Objects
|
||||
- `username` *string*
|
||||
- `loginNames` Array of *string*
|
||||
- `preferredLoginName` *string*
|
||||
- `human`
|
||||
Set if the user is human
|
||||
- `human`
|
||||
Set if User (Human)
|
||||
- `firstName` *string*
|
||||
- `lastName` *string*
|
||||
- `nickName` *string*
|
||||
|
||||
@@ -14,7 +14,7 @@ The [OpenID Connect & OAuth endpoints](/apis/openidoauth/endpoints) and [SAML 2.
|
||||
|
||||
## Authentication & authorization
|
||||
|
||||
### Authentication for human users (interactive)
|
||||
### Authentication for users (interactive)
|
||||
|
||||
ZITADEL implements industry standards such as OpenID Connect, OAuth 2.0, or SAML for authentication.
|
||||
Please refer to our guides how to [authenticate users](/guides/integrate/login/login-users) through an interactive authentication process.
|
||||
@@ -23,10 +23,10 @@ For user authentication on devices with limited accessibility (eg, SmartTV, Smar
|
||||
|
||||
Additionally, you can use the [session API](/reference/api/session) to authenticate users, for example by building a [custom login UI](/guides/integrate/login-ui).
|
||||
|
||||
### Authenticate service users and machines
|
||||
### Authenticate service accounts
|
||||
|
||||
Service users allow for machine-to-machine (M2M) communication.
|
||||
Follow the guides to learn how to [authenticate service users](/guides/integrate/service-users/authenticate-service-users).
|
||||
Follow the guides to learn how to [authenticate service accounts](/guides/integrate/service-accounts/authenticate-service-accounts).
|
||||
|
||||
Accessing the ZITADEL APIs through a service user might require additional steps, please follow the guide on how to [access ZITADEL APIs](../guides/integrate/zitadel-apis/access-zitadel-apis) to include the correct audience scope in your requests.
|
||||
|
||||
|
||||
@@ -98,8 +98,8 @@ No major changes have been made to the organization requests.
|
||||
When migrating your user management from v1 to v2, the most significant updates involve user states and the initial onboarding process:
|
||||
|
||||
- **Unified User Creation Endpoint**:
|
||||
- A significant simplification in v2 is the consolidation of user creation. There is now one primary endpoint for creating users, regardless of whether they are human or machine users.
|
||||
- You can use this single endpoint to provision both human users (individuals interacting with your application) and machine users (e.g., service accounts, API clients), typically by specifying the user type in the request payload.
|
||||
- A significant simplification in v2 is the consolidation of user creation. There is now one primary endpoint for creating users, regardless of whether they are User (Human) or machine users.
|
||||
- You can use this single endpoint to provision both users (individuals interacting with your application) and service accounts (i.e. API clients), typically by specifying the user type in the request payload.
|
||||
- **No More "Initial" State**:
|
||||
- In v1, new users without a password or verified email were automatically assigned an initial state. This default assumption wasn't always ideal.
|
||||
- In v2, this initial state has been removed. All newly created users are now active by default, regardless of their initial attributes.
|
||||
|
||||
@@ -31,7 +31,7 @@ The base URL for the SCIM endpoint in Zitadel is: `https://${CUSTOM_DOMAIN}/scim
|
||||
## Authentication
|
||||
|
||||
The SCIM interface adheres to Zitadel's standard API authentication methods.
|
||||
For detailed instructions on authenticating with the SCIM interface, refer to the [Authenticate Service Users Guide](/guides/integrate/service-users/authenticate-service-users).
|
||||
For detailed instructions on authenticating with the SCIM interface, refer to the [Authenticate Service Users Guide](/guides/integrate/service-accounts/authenticate-service-accounts).
|
||||
|
||||
## Query
|
||||
|
||||
@@ -826,7 +826,7 @@ curl -G "https://${DOMAIN}/scim/v2/${ORG_ID}/ServiceProviderConfig" \
|
||||
"name": "Zitadel authentication token",
|
||||
"description": "Authentication scheme using the OAuth Bearer Token Standard",
|
||||
"specUri": "https://www.rfc-editor.org/info/rfc6750",
|
||||
"documentationUri": "https://zitadel.com/docs/guides/integrate/service-users/authenticate-service-users",
|
||||
"documentationUri": "https://zitadel.com/docs/guides/integrate/service-accounts/authenticate-service-accounts",
|
||||
"type": "oauthbearertoken",
|
||||
"primary": false
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user