chore: rename configuration to settings (#11568)

# Which Problems Are Solved naming inconsistencies: Configuration <-> Settings # How the Problems Are Solved # Additional Changes # Additional Context - Closes #11282
2026-11-08 07:05:12 +00:00 · 2026-02-18 14:25:42 +01:00
parent 64065bbe3c
commit 699ed17918
129 changed files with 359 additions and 359 deletions
@@ -8,7 +8,7 @@ title: OAuth 2.0 Proxy

 ### Setup Application and get Keys

-Before we can start building our application we have do do a few configuration steps in ZITADEL Console.
+Before we can start building our application we have to do a few setup steps in ZITADEL Console.
 You will need to provide some information about your app. We recommend creating a new app to start from scratch. Navigate to your project and add a new application at the top of the page.
 Select Web Application and continue.
 We recommend that you use [Authorization Code](/apis/openidoauth/grant-types#authorization-code) for the OAuth 2.0 Proxy.
@@ -61,7 +61,7 @@ http_address = "127.0.0.1:4180" #localdev only

 ### Check for groups

-If you want oauth2-proxy to check for roles in the tokens you have to add an [action](/guides/manage/console/actions-overview) in ZITADEL to [complement the token](/guides/manage/console/actions-overview) in ZITADEL to [complement the token](/apis/actions/complement-token) according to [this example](/guides/manage/console/actions-overview) in ZITADEL to [complement the token](/apis/actions/complement-token) according to [this example](https://github.com/zitadel/actions/blob/main/examples/custom_roles.js) and add the following configuration to the config:
+If you want oauth2-proxy to check for roles in the tokens you have to add an [action](/guides/manage/console/actions-overview) in ZITADEL to [complement the token](/guides/manage/console/actions-overview) in ZITADEL to [complement the token](/apis/actions/complement-token) according to [this example](/guides/manage/console/actions-overview) in ZITADEL to [complement the token](/apis/actions/complement-token) according to [this example](https://github.com/zitadel/actions/blob/main/examples/custom_roles.js) and add the following settings to the config:

 ```toml
 oidc_groups_claim = "{your_actions_group_key}"
@@ -10,7 +10,7 @@

 ![](../../../public/img/examples/secure-api/app-jwt/3.png)

-4. Now review your configuration and click **Create**.
+4. Now review your settings and click **Create**.

 ![](../../../public/img/examples/secure-api/app-jwt/4.png)

@@ -12,7 +12,7 @@ By the end of this guide, your application will have login functionality and wil

 ## Set up application and obtain keys

-Before we begin developing our application, we need to perform a few configuration steps in the ZITADEL Console.
+Before we begin developing our application, we need to perform a few setup steps in the ZITADEL Console.
 You'll need to provide some information about your app. We recommend creating a new app to start from scratch. Navigate to your Project, then add a new application at the top of the page.
 Select the **User Agent** application type and continue.
 We recommend that you use [Proof Key for Code Exchange (PKCE)](/apis/openidoauth/grant-types#proof-key-for-code-exchange) for all SPA applications.
@@ -146,7 +146,7 @@ https://github.com/zitadel/zitadel-angular/blob/main/src/app/components/user/use

 ### Refresh token

-If you want to add a refresh token to your application, navigate to the management console application and check the box in the configuration section.
+If you want to add a refresh token to your application, navigate to the management console application and check the box in the settings section.
 Then add `offline_access` to the scopes and add the following line:

 ```
@@ -159,7 +159,7 @@ This line automatically refreshes a token before it expires.

 Congratulations! You have successfully integrated your Angular application with ZITADEL!

-If you get stuck, consider checking out our [example](https://github.com/zitadel/zitadel-angular) application. This application includes all the functionalities mentioned in this quick-start. You can start by cloning the repository and replacing the _AuthConfig_ in the _AppModule_ with your own configuration. If you face issues, contact us or raise an issue on [GitHub](https://github.com/zitadel/zitadel).
+If you get stuck, consider checking out our [example](https://github.com/zitadel/zitadel-angular) application. This application includes all the functionalities mentioned in this quick-start. You can start by cloning the repository and replacing the _AuthConfig_ in the _AppModule_ with your own settings. If you face issues, contact us or raise an issue on [GitHub](https://github.com/zitadel/zitadel).

 ![App in management console](../../../public/img/angular/app-screen.png)

@@ -12,7 +12,7 @@ If you need any other information about Flutter, head over to the [documentation

 ## Setup Application

-Before we can start building our application, we have to do a few configuration steps in ZITADEL Console.
+Before we can start building our application, we have to do a few setup steps in ZITADEL Console.
 You will need to provide some information about your app. We recommend creating a new app to start from scratch. Navigate to your Project, then add a new application at the top of the page.
 Select **Native** application type and continue.

@@ -17,7 +17,7 @@ By the end of this guide, your application will have login functionality and wil

 ## Set up application

-Before we begin developing our application, we need to perform a few configuration steps in the ZITADEL Console.
+Before we begin developing our application, we need to perform a few setup steps in the ZITADEL Console.
 You'll need to provide some information about your app. We recommend creating a new app to start from scratch. Navigate to your Project, then add a new application at the top of the page.
 Select the **Web** application type and continue.

@@ -152,4 +152,4 @@ Congratulations! You have successfully integrated your Go application with ZITAD

 If you get stuck, consider checking out our [example](https://github.com/zitadel/zitadel-go) application.
 This application includes all the functionalities mentioned in this quickstart.
-You can directly start it with your own configuration. If you face issues, contact us or raise an issue on [GitHub](https://github.com/zitadel/zitadel-go/issues).
+You can directly start it with your own settings. If you face issues, contact us or raise an issue on [GitHub](https://github.com/zitadel/zitadel-go/issues).
@@ -15,7 +15,7 @@ You can either create your own application or directly run the example by provid

 ## Set up application

-Before we begin developing our application, we need to perform a few configuration steps in the ZITADEL Console.
+Before we begin developing our application, we need to perform a few setup steps in the ZITADEL Console.
 You'll need to provide some information about your app. We recommend creating a new app to start from scratch. Navigate to your Project, then add a new application at the top of the page.
 Select the **Web** application type and continue.

@@ -73,7 +73,7 @@ https://github.com/zitadel/zitadel-java/blob/main/web/src/main/java/demo/support
 https://github.com/zitadel/zitadel-java/blob/main/web/src/main/java/demo/support/AccessTokenInterceptor.java
 ```

-### Application server configuration
+### Application server settings

 As we have now our support classes, we can now create and configure the application server (and API client) itself.

@@ -90,7 +90,7 @@ mapping the claims (using the ZitadelGrantedAuthoritiesMapper) and also provide
 https://github.com/zitadel/zitadel-java/blob/main/web/src/main/java/demo/config/WebSecurityConfig.java
 ```

-For the authentication (and the server in general) to work, the application needs some configuration, so please provide the following to your `application.yml` (resources folder):
+For the authentication (and the server in general) to work, the application needs some settings, so please provide the following to your `application.yml` (resources folder):

 ```yaml reference
 https://github.com/zitadel/zitadel-java/blob/main/web/src/main/resources/application.yml
@@ -173,4 +173,4 @@ Congratulations! You have successfully integrated your Spring Boot web applicati

 If you get stuck, consider checking out our [example](https://github.com/zitadel/zitadel-java) application.
 This application includes all the functionalities mentioned in this quickstart.
-You can directly start it with your own configuration. If you face issues, contact us or raise an issue on [GitHub](https://github.com/zitadel/zitadel-java/issues).
+You can directly start it with your own settings. If you face issues, contact us or raise an issue on [GitHub](https://github.com/zitadel/zitadel-java/issues).
@@ -74,7 +74,7 @@ Make sure to select `Project Owner Viewer` as the management role.

 To show granted projects, go to the `Demo-Vendor` organization and add the Service Account as `Org Project Permission Editor` Manager.

-## Configuration
+## Setup

 Now clone this project and navigate to its root folder.
 Create a file `.env.local` and copy and paste the following:
@@ -102,7 +102,7 @@ Replace the values as follows

 `PROJECT_ID`: You can find `${PROJECT_ID}` by clicking on "Projects" in the navigation and select the Project `Portal`. `${PROJECT_ID}` is displayed on the top as "Resource ID".

-`ZITADEL_CLIENT_ID`: Having the project `Portal` selected, click on the Application `portal-web`. `${CLIENT_ID}` is displayed as a field in the OIDC configuration, labeled "Client ID" and has the format `12345678@portal`.
+`ZITADEL_CLIENT_ID`: Having the project `Portal` selected, click on the Application `portal-web`. `${CLIENT_ID}` is displayed as a field in the OIDC settings, labeled "Client ID" and has the format `12345678@portal`.

 `SERVICE_ACCOUNT_ACCESS_TOKEN`: Set up a service account, add a Personal Access Token, and copy the secret here (see below).

@@ -27,7 +27,7 @@ then open [http://localhost:3000](http://localhost:3000) with your browser to se

 ## Setup Application and Get Keys

-Before we can start building our application, we have to do a few configuration steps in ZITADEL Console.
+Before we can start building our application, we have to do a few setup steps in ZITADEL Console.
 You will need to provide some information about your app.

 Navigate to your Project, then add a new application at the top of the page.
@@ -54,10 +54,10 @@ After successful app creation, a pop-up will appear, showing the app's client ID

 Now that you have your web application configured on the ZITADEL side, you can go ahead and integrate your NextJS app.

-### Configuration
+### Setup

 NextAuth.js exposes a REST API which is used by your application.
-To setup your configuration, create a file called `src/lib/auth.ts`.
+To setup your auth, create a file called `src/lib/auth.ts`.
 You can directly import the ZITADEL provider from [next-auth](https://next-auth.js.org/providers/zitadel).

 ```ts reference
@@ -18,7 +18,7 @@ This documentation references our [example](https://github.com/zitadel/example-d

 ## ZITADEL setup

-Before we can start building our application, we have to do a few configuration steps in ZITADEL Management Console.
+Before we can start building our application, we have to do a few setup steps in ZITADEL Management Console.

 ### Project roles

@@ -83,7 +83,7 @@ The secret will not be displayed again, but you can regenerate one if you loose

 For this example we need the following dependencies:
 - `django`: to create an API with django
- `python-dotenv`: to use environment variables in the configuration
+- `python-dotenv`: to use environment variables in the settings
 - `mozilla-django-oidc`: client-side OIDC functionality

 For the dependencies we need a requirements.txt-file with the following content:
@@ -137,13 +137,13 @@ AUTHENTICATION_BACKENDS = (
 )
 ```

-Add configuration:
+Add settings:

 ```python reference
 https://github.com/zitadel/example-python-django-oidc/blob/main/mysite/settings.py#L130-L174
 ```

-and create a ".env"-file in the root folder with the configuration:
+and create a ".env"-file in the root folder with the settings:

 ```bash
 ZITADEL_PROJECT = "ID of the project you created the application in ZITADEL"
@@ -10,12 +10,12 @@ By the end of this guide, your application will have login functionality and wil

 <Callout>
 This documentation references our [example](https://github.com/zitadel/zitadel-react) on GitHub.
-It also uses the @zitadel/react package with its default configuration.
+It also uses the @zitadel/react package with its default settings.
 </Callout>

 ## Set up application and obtain keys

-Before we begin developing our application, we need to perform a few configuration steps in the ZITADEL Console.
+Before we begin developing our application, we need to perform a few setup steps in the ZITADEL Console.
 You'll need to provide some information about your app.
 We recommend creating a new app to start from scratch.
 Navigate to your project, then add a new application at the top of the page.
@@ -14,7 +14,7 @@ This documentation references our [example](https://github.com/zitadel/example-s

 ## ZITADEL setup

-Before we can start building our application, we have to do a few configuration steps in ZITADEL Console.
+Before we can start building our application, we have to do a few setup steps in ZITADEL Console.

 ### Project roles

@@ -10,12 +10,12 @@ By the end of this guide, your application will have login functionality and wil

 <Callout title="">
 This documentation references our [example](https://github.com/zitadel/zitadel-vue) on GitHub.
-It also uses the @zitadel/vue package with its default configuration.
+It also uses the @zitadel/vue package with its default settings.
 </Callout>

 ## Set up application and obtain keys

-Before we begin developing our application, we need to perform a few configuration steps in the ZITADEL Management Console.
+Before we begin developing our application, we need to perform a few setup steps in the ZITADEL Management Console.
 You'll need to provide some information about your app.
 We recommend creating a new app to start from scratch.
 Navigate to your project, then add a new application at the top of the page.
@@ -21,7 +21,7 @@ All that is required, is to create your API, create a private key and a personal

 ### Set up application and obtain keys

-Before we begin developing our API, we need to perform a few configuration steps in the ZITADEL Console.
+Before we begin developing our API, we need to perform a few setup steps in the ZITADEL Console.
 You'll need to provide some information about your app. We recommend creating a new app to start from scratch.

 Starting from the homepage of your management console, click on Create Application
@@ -15,7 +15,7 @@ You can either create your own application or directly run the example by provid

 ## Set up application

-Before we begin developing our API, we need to perform a few configuration steps in the ZITADEL Console.
+Before we begin developing our API, we need to perform a few setup steps in the ZITADEL Console.
 You'll need to provide some information about your app. We recommend creating a new app to start from scratch. Navigate to your Project, then add a new application at the top of the page.
 Select the **API** application type and continue.

@@ -47,7 +47,7 @@ So in your application, create a `support/zitadel` package and in there the `Cus
 https://github.com/zitadel/zitadel-java/blob/main/api/src/main/java/demo/app/support/zitadel/CustomAuthorityOpaqueTokenIntrospector.java
 ```

-### Application server configuration
+### Application server settings

 As we have now our support class, we can now create and configure the application server itself.

@@ -59,7 +59,7 @@ It will also use the just created CustomAuthorityOpaqueTokenIntrospector for the
 https://github.com/zitadel/zitadel-java/blob/main/api/src/main/java/demo/app/config/WebSecurityConfig.java
 ```

-For the authorization (and the server in general) to work, the application needs some configuration, so please provide the following to your `application.yml` (resources folder):
+For the authorization (and the server in general) to work, the application needs some settings, so please provide the following to your `application.yml` (resources folder):

 ```yaml reference
 https://github.com/zitadel/zitadel-java/blob/main/api/src/main/resources/application.yml
@@ -23,7 +23,7 @@ The NestJS API includes a private endpoint `GET http://localhost:${APP_PORT}/api

 Make sure you have Node.js and npm installed on your machine.

-### ZITADEL Configuration for the API
+### ZITADEL Setup for the API

 1. Create a ZITADEL instance and a project by following the steps [here](/guides/start/quickstart#3-create-your-zitadel-instance).

@@ -14,7 +14,7 @@ By the end of this guide, your application will have three different endpoint wh

 ## ZITADEL setup

-Before we can start building our application, we have to do a few configuration steps in ZITADEL Management Console.
+Before we can start building our application, we have to do a few setup steps in ZITADEL Management Console.

 ### Create application

@@ -42,7 +42,7 @@ And the following from the Service Account:

 ## Setup new Pylon service

-Pylon allows you to create a new service using the `npm create pylon` command. This command creates a new Pylon project with a basic project structure and configuration.
+Pylon allows you to create a new service using the `npm create pylon` command. This command creates a new Pylon project with a basic project structure and settings.
 During the setup process, you can choose your preferred runtime, such as Bun, Node.js, or Cloudflare Workers.

 **This guide uses the Bun runtime.**
@@ -98,7 +98,7 @@ export default app;

 ### Add ZITADEL info to the service

-1. Create a `.env` file in the root folder of your project and add the following configuration:
+1. Create a `.env` file in the root folder of your project and add the following settings:

 ```bash
 AUTH_ISSUER='URL to the zitadel instance'
@@ -19,7 +19,7 @@ This documentation references our [example](https://github.com/zitadel/example-d

 ## ZITADEL setup

-Before we can start building our application, we have to do a few configuration steps in ZITADEL Management Console.
+Before we can start building our application, we have to do a few setup steps in ZITADEL Management Console.

 ### Create application

@@ -55,7 +55,7 @@ And the following from the Service Account:

 For this example we need the following dependencies:
 - `django`: to create an API with django
- `python-dotenv`: to use environment variables in the configuration
+- `python-dotenv`: to use environment variables in the settings
 - `authlib`: client-side OAuth functionality
 - `requests`: HTTP requests for the introspection

@@ -85,7 +85,7 @@ There is info needed for the introspection calls, which we put into the settings
 https://github.com/zitadel/example-python-django-oauth/blob/main/myapi/settings.py#L125-L133
 ```

-and create a ".env"-file in the root folder with the configuration as an example:
+and create a ".env"-file in the root folder with the settings as an example:
 ```bash
 ZITADEL_INTROSPECTION_URL = 'URL to the introspection endpoint to verify the provided token'
 ZITADEL_DOMAIN = 'Domain used as audience in the token verification'
@@ -23,7 +23,7 @@ In this example we will use a service account with a [personal access token](/gu

 In order to run the example you need to have `python3` and `pip3` installed.

-### ZITADEL configuration for the API
+### ZITADEL settings for the API

 ![](../../../public/img/python-flask/2.png)

@@ -174,7 +174,7 @@ class ZitadelIntrospectTokenValidator(IntrospectTokenValidator):
        return res
 ```

-3. Create a new file named ".env" in the directory. Copy the configuration in the [".env.example"](https://github.com/zitadel/example-api-python3-flask/blob/main/.env.example) file to the newly created .env file. Set the values with your Custom Domain/Issuer URL, Client ID, and Client Secret from the previous steps. Obtain your Issuer URL by following [these steps](/guides/start/quickstart#5-collect-your-integration-keys).
+3. Create a new file named ".env" in the directory. Copy the settings in the [".env.example"](https://github.com/zitadel/example-api-python3-flask/blob/main/.env.example) file to the newly created .env file. Set the values with your Custom Domain/Issuer URL, Client ID, and Client Secret from the previous steps. Obtain your Issuer URL by following [these steps](/guides/start/quickstart#5-collect-your-integration-keys).

 ```python
 ZITADEL_DOMAIN = "https://custom-domain-abcdef.zitadel.cloud"
@@ -182,7 +182,7 @@ CLIENT_ID = "197....@projectname"
 CLIENT_SECRET = "NVAp70IqiGmJldbS...."
 ```

-### ZITADEL configuration to create a service account
+### ZITADEL settings to create a service account

 ![](../../../public/img/python-flask/3.png)