mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-19 03:35:12 +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:
@@ -117,7 +117,7 @@ curl -L -X PUT 'https://${CUSTOM_DOMAIN}/v2/actions/executions' \
|
||||
## Example call
|
||||
|
||||
Now that you have set up the target and execution, you can test it by creating a user through the Management Console UI or
|
||||
by calling the ZITADEL API to create a human user.
|
||||
by calling the ZITADEL API to create a user.
|
||||
|
||||
```shell
|
||||
curl -L -X POST 'https://${CUSTOM_DOMAIN}/v2/users/new' \
|
||||
|
||||
@@ -171,7 +171,7 @@ curl -L -X PUT 'https://${CUSTOM_DOMAIN}/v2/actions/executions' \
|
||||
## Example call
|
||||
|
||||
Now that you have set up the target and execution, you can test it by creating a user through the Management Console UI or
|
||||
by calling the ZITADEL API to create a human user.
|
||||
by calling the ZITADEL API to create a user.
|
||||
|
||||
```shell
|
||||
curl -L -X POST 'https://${CUSTOM_DOMAIN}/v2/users/new' \
|
||||
|
||||
@@ -152,7 +152,7 @@ You can do this by using **Webhook.site** (see [Creating a Listener with Webhook
|
||||
## Example call
|
||||
|
||||
Now that you have set up the target and execution, you can test it by creating a user through the Management Console UI or
|
||||
by calling the ZITADEL API to create a human user.
|
||||
by calling the ZITADEL API to create a user.
|
||||
|
||||
```shell
|
||||
curl -L -X POST 'https://${CUSTOM_DOMAIN}/v2/users/new' \
|
||||
|
||||
@@ -121,7 +121,7 @@ curl -L -X PUT 'https://${CUSTOM_DOMAIN}/v2/actions/executions' \
|
||||
## Example call
|
||||
|
||||
Now that you have set up the target and execution, you can test it by creating a user through the Management Console UI or
|
||||
by calling the ZITADEL API to create a human user.
|
||||
by calling the ZITADEL API to create a user.
|
||||
|
||||
```shell
|
||||
curl -L -X POST 'https://${CUSTOM_DOMAIN}/v2/users/new' \
|
||||
|
||||
@@ -121,7 +121,7 @@ curl -L -X PUT 'https://${CUSTOM_DOMAIN}/v2/actions/executions' \
|
||||
## Example call
|
||||
|
||||
Now that you have set up the target and execution, you can test it by creating a user through the Management Console UI or
|
||||
by calling the ZITADEL API to create a human user.
|
||||
by calling the ZITADEL API to create a user.
|
||||
|
||||
```shell
|
||||
curl -L -X POST 'https://${CUSTOM_DOMAIN}/v2/users/new' \
|
||||
|
||||
@@ -137,7 +137,7 @@ curl -L -X PUT 'https://${CUSTOM_DOMAIN}/v2/actions/executions' \
|
||||
|
||||
## 7. Example Call
|
||||
|
||||
Now that you have set up the target and execution, you can test it by creating a user through the Management Console UI or by calling the ZITADEL API to create a human user.
|
||||
Now that you have set up the target and execution, you can test it by creating a user through the Management Console UI or by calling the ZITADEL API to create a user.
|
||||
|
||||
Here, we are creating a user via the API:
|
||||
|
||||
|
||||
@@ -178,7 +178,7 @@ You can also activate the v2 login for your apps, so users are redirected to `/u
|
||||
|
||||
The simplest way to deploy the new login for yourself is by using the [Deploy with Vercel button](https://github.com/zitadel/zitadel/blob/main/CONTRIBUTING.md#login-deploy) to deploy the login directly to your Vercel.
|
||||
|
||||
1. [Create a service user](/guides/integrate/service-users/personal-access-token#create-a-service-user-with-a-pat) with a PAT in your instance
|
||||
1. [Create a service user](/guides/integrate/service-accounts/personal-access-token#create-a-service-user-with-a-pat) with a PAT in your instance
|
||||
2. Give the user IAM_LOGIN_CLIENT Permissions in the default settings (CUSTOM_DOMAIN/ui/console/instance?id=organizations)
|
||||
Note: [Zitadel Manager Guide](/guides/manage/console/managers)
|
||||
3. Deploy login to Vercel: You can do so by directly clicking the [“Deploy” button](https://github.com/zitadel/zitadel/blob/main/CONTRIBUTING.md#login-deploy) in our [repository](https://github.com/zitadel/zitadel)
|
||||
|
||||
@@ -12,7 +12,7 @@ Roles are critical to managing permissions in a single-tenant or multi-tenant ap
|
||||
|
||||
## Assign roles and memberships
|
||||
|
||||
Human or service users can be assigned roles. You can do this via the ZITADEL Management Console or the ZITADEL APIs. As mentioned earlier, there are two types of roles in ZITADEL. You can have your own application-specific roles, and alternatively, ZITADEL also has administrator roles, such as `ORG_OWNER` and `IAM_OWNER`.
|
||||
Users or service accounts can be assigned roles. You can do this via the ZITADEL Management Console or the ZITADEL APIs. As mentioned earlier, there are two types of roles in ZITADEL. You can have your own application-specific roles, and alternatively, ZITADEL also has administrator roles, such as `ORG_OWNER` and `IAM_OWNER`.
|
||||
|
||||
Follow the links below to assign roles to your users.
|
||||
|
||||
@@ -27,12 +27,12 @@ Roles can be requested via our auth and management APIs, from userinfo endpoint
|
||||
|
||||
### Generate a token
|
||||
|
||||
You must first of all generate a token for the user. For human users, the typical approach involves using a front-end application and logging in through the browser or device. An access token will be returned after they log in successfully. A machine user will use a script or other program to generate a token using the JWT profile or client credentials grant types.
|
||||
You must first of all generate a token for the user. For users, the typical approach involves using a front-end application and logging in through the browser or device. An access token will be returned after they log in successfully. A service account will use a script or other program to generate a token using the JWT profile or client credentials grant types.
|
||||
|
||||
How to generate a token:
|
||||
|
||||
- [Generate tokens for human users](/guides/integrate/login/oidc/login-users)
|
||||
- [Generate tokens for service users](/guides/integrate/service-users/authenticate-service-users)
|
||||
- [Generate tokens for users](/guides/integrate/login/oidc/login-users)
|
||||
- [Generate tokens for service accounts](/guides/integrate/service-accounts/authenticate-service-accounts)
|
||||
|
||||
In order to access role information via the token you must include the right audience and the necessary role claims in the scope and/or select the required role settings in the ZITADEL management console before requesting the token.
|
||||
|
||||
|
||||
@@ -32,7 +32,7 @@ SCIM provisioning in ZITADEL is accomplished by authenticating a Service User wi
|
||||
|
||||
* Client Credentials Grant
|
||||
|
||||
4. Detailed instructions to authenticate the Service User can be found [here](https://zitadel.com/docs/guides/integrate/service-users/authenticate-service-users).
|
||||
4. Detailed instructions to authenticate the Service User can be found [here](https://zitadel.com/docs/guides/integrate/service-accounts/authenticate-service-accounts).
|
||||
|
||||
## Step 2: Set Up SCIM in Okta
|
||||
|
||||
@@ -112,7 +112,7 @@ Review and adjust attribute mappings in Okta as needed:
|
||||
|
||||
* [ZITADEL: Creating Service Users](https://zitadel.com/docs/guides/manage/console/users-overview)
|
||||
|
||||
* [ZITADEL: Service User Authentication](https://zitadel.com/docs/guides/integrate/service-users/authenticate-service-users)
|
||||
* [ZITADEL: Service User Authentication](https://zitadel.com/docs/guides/integrate/service-accounts/authenticate-service-accounts)
|
||||
|
||||
* [ZITADEL SCIM 2.0 API Endpoints](https://zitadel.com/docs/apis/scim2)
|
||||
|
||||
|
||||
+5
-5
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Authenticate service users and client applications
|
||||
sidebar_label: Authenticate service users
|
||||
title: Authenticate service accounts and client applications
|
||||
sidebar_label: Authenticate service accounts
|
||||
---
|
||||
|
||||
import DocCardList from '@/components/docusaurus/doc-card-list';
|
||||
@@ -12,7 +12,7 @@ This guide explains ZITADEL service users and their role in facilitating secure
|
||||
Service users in ZITADEL represent **non-human entities** within your system.
|
||||
They are ideal for scenarios involving secure communication between applications, particularly when interacting with backend services or APIs.
|
||||
Service users in combination with [Manager](/concepts/structure/managers) permissions are used to access ZITADEL's APIs, for example, to manage user resources.
|
||||
Unlike regular human users, service users don't rely on traditional login methods (e.g., username/password) and require alternative authentication mechanisms.
|
||||
Unlike users, service accounts don't rely on traditional login methods (e.g., username/password) and require alternative authentication mechanisms.
|
||||
|
||||
## Benefits of using Service Users
|
||||
|
||||
@@ -84,7 +84,7 @@ This method is still available in ZITADEL but is generally considered less secur
|
||||
### Personal Access Tokens (PATs)
|
||||
|
||||
* **Ready-to-use tokens:** Generated for specific service users and can be directly included in the authorization header of API requests.
|
||||
* **Currently available only for machine users** (service users) and not regular human users.
|
||||
* **Currently available only for service accounts** and not users.
|
||||
|
||||
Follow our guide on using [personal access tokens](./personal-access-token) to get started authenticating service users and applications.
|
||||
|
||||
@@ -127,7 +127,7 @@ However, [client credentials authentication](./client-credentials) might be cons
|
||||
|
||||
## Further resources
|
||||
|
||||
* Read about the [different methods to authenticate service users](./authenticate-service-users)
|
||||
* Read about the [different methods to authenticate service users](./authenticate-service-accounts)
|
||||
* [Service User API reference](/reference/api/user)
|
||||
* [OIDC JWT with private key](/apis/openidoauth/authn-methods#jwt-with-private-key) authentication method reference
|
||||
* [Access ZITADEL APIs](../zitadel-apis/access-zitadel-apis)
|
||||
+3
-3
@@ -3,9 +3,9 @@ title: Configure client credential authentication for service users
|
||||
sidebar_label: Client credential authentication
|
||||
---
|
||||
|
||||
This guide demonstrates how developers can leverage Client Credential authentication to secure communication between [service users](/guides/manage/console/users-overview#service-users-machine-accounts) and client applications within ZITADEL.
|
||||
This guide demonstrates how developers can leverage Client Credential authentication to secure communication between [service users](/guides/manage/console/users-overview#service-accounts) and client applications within ZITADEL.
|
||||
|
||||
In ZITADEL, the Client Credentials Flow can be used for this [non-interactive authentication](./authenticate-service-users) as alternative to the [JWT profile authentication](./authenticate-service-users).
|
||||
In ZITADEL, the Client Credentials Flow can be used for this [non-interactive authentication](./authenticate-service-accounts) as alternative to the [JWT profile authentication](./authenticate-service-accounts).
|
||||
|
||||
## Steps to authenticate a Service User with client credentials
|
||||
|
||||
@@ -101,7 +101,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)
|
||||
* Read about the [different methods to authenticate service users](./authenticate-service-accounts)
|
||||
* [Service User API reference](/reference/api/user)
|
||||
* [OIDC client secret basic](/apis/openidoauth/authn-methods#client-secret-basic) authentication method reference
|
||||
* [Access ZITADEL APIs](../zitadel-apis/access-zitadel-apis)
|
||||
+1
-1
@@ -6,7 +6,7 @@ sidebar_label: Personal access token authentication
|
||||
A Personal Access Token (PAT) is a ready to use token which can be used as _Authorization_ header.
|
||||
At the moment ZITADEL only allows PATs for machine accounts (service users).
|
||||
|
||||
It is an alternative to the [private key JWT](./private-key-jwt) and [client credentials](./client-credentials). Read more about the different [authentication methods for service users](./authenticate-service-users).
|
||||
It is an alternative to the [private key JWT](./private-key-jwt) and [client credentials](./client-credentials). Read more about the different [authentication methods for service users](./authenticate-service-accounts).
|
||||
|
||||
## Create a Service User with a PAT
|
||||
|
||||
+1
-1
@@ -7,7 +7,7 @@ This guide explains how developers can use private key JWT authentication to sec
|
||||
|
||||
In ZITADEL, the `urn:ietf:params:oauth:grant-type:jwt-bearer` (**"JWT bearer token with private key"**, [RFC7523](https://tools.ietf.org/html/rfc7523)) authorization grant type is used for non-interactive authentication.
|
||||
|
||||
Read more about the [different authentication methods for service users](./authenticate-service-users), including their benefits, drawbacks, and security considerations.
|
||||
Read more about the [different authentication methods for service users](./authenticate-service-accounts), including their benefits, drawbacks, and security considerations.
|
||||
|
||||
#### How private key JWT authentication works
|
||||
|
||||
@@ -27,7 +27,7 @@ If you have an API that behaves as an OAuth resource server that can be accessed
|
||||
|
||||
If there are client APIs or systems that need to access other protected APIs, these APIs or systems must be declared as [service users](/guides/manage/console/users-overview).
|
||||
A service user is not considered an application type in ZITADEL.
|
||||
Read the introduction on how to [authenticate service users](/guides/integrate/service-users/authenticate-service-users).
|
||||
Read the introduction on how to [authenticate service users](/guides/integrate/service-accounts/authenticate-service-accounts).
|
||||
|
||||
## Further references
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import IntrospectionResponse from './_introspection-response.mdx';
|
||||
|
||||
This guide explains how to use ZITADEL's [Private Key JWT authentication method](/apis/openidoauth/authn-methods#jwt-with-private-key) to authenticate your application and call the token introspection endpoint. This is not about securing an API, but about allowing your backend to introspect access tokens in a secure way.
|
||||
|
||||
If you're looking to set up Private Key JWT authentication specifically for Service Users, see our dedicated guide [here](/guides/integrate/service-users/private-key-jwt).
|
||||
If you're looking to set up Private Key JWT authentication specifically for Service Users, see our dedicated guide [here](/guides/integrate/service-accounts/private-key-jwt).
|
||||
|
||||
## Register an Application & Generate a Key Pair
|
||||
|
||||
|
||||
@@ -27,9 +27,9 @@ For further details and in-depth exploration, you can refer to the [ZITADEL API
|
||||
|
||||
Accessing ZITADEL APIs, except for the Auth API and the System API, requires these basic steps:
|
||||
|
||||
1. **Create a service user**: A service user is a special type of account used to grant programmatic access to ZITADEL's functionalities. Unlike regular users who log in with a username and password, [service users rely on a more secure mechanism involving digital keys and tokens](../service-users/authenticate-service-users).
|
||||
1. **Create a service user**: A service user is a special type of account used to grant programmatic access to ZITADEL's functionalities. Unlike regular users who log in with a username and password, [service users rely on a more secure mechanism involving digital keys and tokens](../service-accounts/authenticate-service-accounts).
|
||||
2. **Give permission to access ZITADEL APIs**: Assign a Administrator role to the service user, giving it permission to make changes to certain resources in ZITADEL.
|
||||
3. **Authenticate the service user**: Like human users, service users must authenticate and request an OAuth token with the scope `urn:zitadel:iam:org:project:id:zitadel:aud` to access ZITADEL APIs. [Service users can be authenticated](../service-users/authenticate-service-users) using private key JWT, client credentials, or personal access tokens.
|
||||
3. **Authenticate the service account**: Like users, service accounts must authenticate and request an OAuth token with the scope `urn:zitadel:iam:org:project:id:zitadel:aud` to access ZITADEL APIs. [Service accounts can be authenticated](../service-accounts/authenticate-service-accounts) using private key JWT, client credentials, or personal access tokens.
|
||||
4. **Access ZITADEL APIs with the token**: The OAuth token must be included in the Authorization Header of calls to ZITADEL APIs.
|
||||
|
||||
### Accessing Auth API
|
||||
@@ -84,7 +84,7 @@ To be able to access the ZITADEL APIs your service user needs permissions to ZIT
|
||||
## 3. Authenticate service user and request token
|
||||
|
||||
Service users can be authenticated using private key JWT, client credentials, or personal access tokens.
|
||||
The [service user authentication](../service-users/authenticate-service-users) can be used to make machine-to-machine requests to any Resource Server (eg, a backend service / API) by requesting a token from the Authorization Server (ZITADEL) and sending the short-lived token (access token) in the Header of requests.
|
||||
The [service user authentication](../service-accounts/authenticate-service-accounts) can be used to make machine-to-machine requests to any Resource Server (eg, a backend service / API) by requesting a token from the Authorization Server (ZITADEL) and sending the short-lived token (access token) in the Header of requests.
|
||||
|
||||
This guide covers a specific case of service user authentication when requesting access to the [ZITADEL APIs](/apis/introduction).
|
||||
While PAT can be used directly to access the ZITADEL APIS, the more secure authentication methods private key JWT and client credentials must include the [reserved scope](/apis/openidoauth/scopes) `urn:zitadel:iam:org:project:id:zitadel:aud` when requesting an access from the token endpoint.
|
||||
@@ -95,7 +95,7 @@ The following sections will explain the more specific authentication to access t
|
||||
|
||||
### Authenticate with private key JWT
|
||||
|
||||
Follow the steps in this guide to [generate an key file](../service-users/private-key-jwt#2-register-a-private-key-for-your-service-user) and [create a JWT and sign with private key](../service-users/private-key-jwt#3-create-a-jwt-and-sign-it-with-your-private-key).
|
||||
Follow the steps in this guide to [generate an key file](../service-accounts/private-key-jwt#2-register-a-private-key-for-your-service-user) and [create a JWT and sign with private key](../service-accounts/private-key-jwt#3-create-a-jwt-and-sign-it-with-your-private-key).
|
||||
|
||||
With the encoded JWT (assertion) from the prior step, you will need to craft a POST request to ZITADEL's token endpoint.
|
||||
|
||||
@@ -232,4 +232,4 @@ curl --request GET \
|
||||
- [Example application in Go](./example-zitadel-api-with-go) to access ZITADEL APIs
|
||||
- [Example application in .NET](./example-zitadel-api-with-dot-net) to access ZITADEL APIs
|
||||
- Learn how to use the [Event API](./event-api) to retrieve your audit trail
|
||||
- Read about the [different methods to authenticate service users](../service-users/authenticate-service-users)
|
||||
- Read about the [different methods to authenticate service users](../service-accounts/authenticate-service-accounts)
|
||||
|
||||
+1
-1
@@ -18,7 +18,7 @@ All that is required, is a service account with an Org Owner (or another role, d
|
||||
However, we recommend you read the guide on [how to access ZITADEL API](/guides/integrate/zitadel-apis/access-zitadel-apis) and the associated guides for a basic knowledge of :
|
||||
|
||||
- [Recommended Authorization Flows](/guides/integrate/login/oidc/oauth-recommended-flows)
|
||||
- [Service Users](/guides/integrate/service-users/authenticate-service-users)
|
||||
- [Service Users](/guides/integrate/service-accounts/authenticate-service-accounts)
|
||||
|
||||
> Be sure to have a valid key JSON and that its service account is either ORG_OWNER or at least ORG_OWNER_VIEWER before you continue with this guide.
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@ All that is required, is a service account with an Org Owner (or another role, d
|
||||
|
||||
However, we recommend you read the guide on [how to access ZITADEL API](/guides/integrate/zitadel-apis/access-zitadel-apis)) and the associated guides for a basic knowledge of :
|
||||
- [Recommended Authorization Flows](/guides/integrate/login/oidc/oauth-recommended-flows)
|
||||
- [Service Users](/guides/integrate/service-users/authenticate-service-users)
|
||||
- [Service Users](/guides/integrate/service-accounts/authenticate-service-accounts)
|
||||
|
||||
> Be sure to have a valid key JSON and that its service account is either ORG_OWNER or at least ORG_OWNER_VIEWER before you continue with this guide.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user