mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-22 12:58:46 +00:00
chore: Service Account Naming Consistency (#11557)
# Which Problems Are Solved Inconsistent naming of service account, found in the following variations: - Machine User - machine user - Service User - Machine Account - Technical Account - User: Type Machine # How the Problems Are Solved Attentive search and replace. Localizations have been translated using Copilot # Additional Changes Some unused methods have been removed from the Go code. # Additional Context - Closes #11285
This commit is contained in:
@@ -0,0 +1,42 @@
|
||||
1. Go to the **Users** tab in your organization as shown below and click on the **Service Accounts** tab.
|
||||
|
||||

|
||||
|
||||
2. To add a service account, click on the **New** button.
|
||||
|
||||

|
||||
|
||||
3. Next, add the details of the service account and select either **Bearer** or **JWT** for **Access Token Type** and click on **Create**. For this example, we will select **JWT**.
|
||||
|
||||

|
||||
|
||||
4. Now you will see the saved details.
|
||||
|
||||

|
||||
|
||||
5. Next, we need to generate a private-public key pair in ZITADEL and you must get the private key to sign your JWT. Go to **Keys** and click on **New**.
|
||||
|
||||

|
||||
|
||||
6. Select type **JSON** and click **Add**.
|
||||
|
||||

|
||||
|
||||
7. Download the key by clicking **Download**. After the download, click **Close**.
|
||||
|
||||

|
||||
|
||||
8. You will see the following screen afterward.
|
||||
|
||||

|
||||
|
||||
9. The downloaded key will be of the following format:
|
||||
|
||||
```
|
||||
{
|
||||
"type":"serviceaccount",
|
||||
"keyId":"<YOUR_KEY_ID>",
|
||||
"key":"-----BEGIN RSA PRIVATE KEY-----\n<YOUR_KEY>\n-----END RSA PRIVATE KEY-----\n",
|
||||
"userId":"<YOUR_USER_ID>"
|
||||
}
|
||||
```
|
||||
@@ -0,0 +1,36 @@
|
||||
In order to access this route, you must create the role `read:messages` in your ZITADEL project and also create an authorization for the service account you created by adding the role to the user. Follow these steps to do so:
|
||||
|
||||
1. Go to your project and select **Roles**. Click **New**.
|
||||
|
||||

|
||||
|
||||
2. Add the `read:messages` role as shown below and click **Save**.
|
||||
|
||||

|
||||
|
||||
3. You will see the created role listed.
|
||||
|
||||

|
||||
|
||||
4. To assign this role to a user, click on **Authorizations**.
|
||||
|
||||

|
||||
|
||||
5. Select the user you want to assign the role to.
|
||||
|
||||

|
||||
|
||||
6. Select the project where this authorization is applicable.
|
||||
|
||||

|
||||
7. Click **Continue**.
|
||||
|
||||

|
||||
|
||||
8. Select the role **read:messages** and click **Save**.
|
||||
|
||||

|
||||
|
||||
9. You will now see the service account has been assigned the role **read:messages**.
|
||||
|
||||

|
||||
@@ -1,42 +0,0 @@
|
||||
1. Go to the **Users** tab in your organization as shown below and click on the **Service Users** tab.
|
||||
|
||||

|
||||
|
||||
2. To add a service user, click on the **New** button.
|
||||
|
||||

|
||||
|
||||
3. Next, add the details of the service user and select either **Bearer** or **JWT** for **Access Token Type** and click on **Create**. For this example, we will select **JWT**.
|
||||
|
||||

|
||||
|
||||
4. Now you will see the saved details.
|
||||
|
||||

|
||||
|
||||
5. Next, we need to generate a private-public key pair in ZITADEL and you must get the private key to sign your JWT. Go to **Keys** and click on **New**.
|
||||
|
||||

|
||||
|
||||
6. Select type **JSON** and click **Add**.
|
||||
|
||||

|
||||
|
||||
7. Download the key by clicking **Download**. After the download, click **Close**.
|
||||
|
||||

|
||||
|
||||
8. You will see the following screen afterward.
|
||||
|
||||

|
||||
|
||||
9. The downloaded key will be of the following format:
|
||||
|
||||
```
|
||||
{
|
||||
"type":"serviceaccount",
|
||||
"keyId":"<YOUR_KEY_ID>",
|
||||
"key":"-----BEGIN RSA PRIVATE KEY-----\n<YOUR_KEY>\n-----END RSA PRIVATE KEY-----\n",
|
||||
"userId":"<YOUR_USER_ID>"
|
||||
}
|
||||
```
|
||||
@@ -1,36 +0,0 @@
|
||||
In order to access this route, you must create the role `read:messages` in your ZITADEL project and also create an authorization for the service user you created by adding the role to the user. Follow these steps to do so:
|
||||
|
||||
1. Go to your project and select **Roles**. Click **New**.
|
||||
|
||||

|
||||
|
||||
2. Add the `read:messages` role as shown below and click **Save**.
|
||||
|
||||

|
||||
|
||||
3. You will see the created role listed.
|
||||
|
||||

|
||||
|
||||
4. To assign this role to a user, click on **Authorizations**.
|
||||
|
||||

|
||||
|
||||
5. Select the user you want to assign the role to.
|
||||
|
||||

|
||||
|
||||
6. Select the project where this authorization is applicable.
|
||||
|
||||

|
||||
7. Click **Continue**.
|
||||
|
||||

|
||||
|
||||
8. Select the role **read:messages** and click **Save**.
|
||||
|
||||

|
||||
|
||||
9. You will now see the service user has been assigned the role **read:messages**.
|
||||
|
||||

|
||||
Reference in New Issue
Block a user