ZITADEL

https://zitadel.com/docs
Admin
ZITADEL is an open-source identity and access management solution that helps you integrate...
Tokens:1,036,796
Snippets:6,646
Trust Score:9.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install and run the Express.js example

Source: https://zitadel.com/docs/sdk-examples/expressjs

Install dependencies and start the development server. The application will be available at http://localhost:3000.

```bash
npm install
npm run dev
```

--------------------------------

### Run the example application

Source: https://zitadel.com/docs/guides/integrate/zitadel-apis/example-zitadel-api-with-go

Starts the example Go application with the required domain and key flags.

```bash
go run cli.go --domain <custom domain> --key <path>
```

--------------------------------

### Quickstart: Download and start ZITADEL with Docker Compose

Source: https://zitadel.com/docs/self-hosting/deploy/compose

Downloads the Docker Compose file and example environment, creates the .env file, and starts the stack. Requires Docker Engine 24+ with the Compose plugin and at least 2 GB RAM.

```bash
mkdir zitadel-compose && cd zitadel-compose

# Download the compose file and example environment
curl -fsSLO https://raw.githubusercontent.com/zitadel/zitadel/main/deploy/compose/docker-compose.yml &&
curl -fsSLO https://raw.githubusercontent.com/zitadel/zitadel/main/deploy/compose/.env.example

# Create your environment file and start
cp .env.example .env
docker compose up -d --wait
```

--------------------------------

### Run setup and start with start-from-setup

Source: https://zitadel.com/docs/self-hosting/manage/database

Runs setup and start for production deployments. Configure TLS to encrypt authentication traffic.

```bash
ZITADEL_DATABASE_POSTGRES_DSN=postgresql://zitadel:<strong-password>@<your-host>:5432/zitadel?sslmode=require \
    zitadel start-from-setup --masterkey "<32-character-key>"
```

--------------------------------

### Run the Go API example

Source: https://zitadel.com/docs/examples/secure-api/go

Start the example server with the required domain and key path flags. The key path points to the service account JSON file.

```bash
go run main.go --domain <custom domain> --key <path>
```

```bash
go run main.go --domain my-domain.zitadel.cloud --key ./api.json
```

--------------------------------

### Start destination database with Docker Compose

Source: https://zitadel.com/docs/self-hosting/manage/cli/mirror

Downloads the Docker Compose example configuration and starts the database container for the destination database.

```bash
# Download the docker compose example configuration.
wget https://raw.githubusercontent.com/zitadel/zitadel/main/docs/self-hosting/deploy/docker-compose.yaml

# Run the database and application containers.
docker compose up db --detach
```

--------------------------------

### Download quickstart values file

Source: https://zitadel.com/docs/self-hosting/deploy/kubernetes

Creates a directory 'zitadel-helm' and downloads the quickstart-values.yaml example from the ZITADEL charts repository.

```bash
mkdir zitadel-helm && cd zitadel-helm &&
curl -fsSLO https://raw.githubusercontent.com/zitadel/zitadel-charts/main/examples/0-quickstart/quickstart-values.yaml
```

--------------------------------

### Run the .NET application

Source: https://zitadel.com/docs/guides/integrate/zitadel-apis/example-zitadel-api-with-dot-net

Start the example application after configuration. This command runs the .NET web application.

```bash
dotnet run
```

--------------------------------

### Expected output from device client example

Source: https://zitadel.com/docs/guides/integrate/login/oidc/device-authorization

The example prints a login instruction with a URL and a device code, then starts polling the token endpoint every 5 seconds until the request is allowed, denied, or times out after 5 minutes.

```text
Please browse to https://test-0o6zvq.zitadel.cloud/device and enter code GQWC-FWFK
INFO[0002] start polling
```

--------------------------------

### Install ZITADEL via Helm

Source: https://zitadel.com/docs/self-hosting/deploy/kubernetes

Adds the ZITADEL Helm repository, updates it, and installs or upgrades the 'zitadel' release using the quickstart values file with --wait.

```bash
helm repo add zitadel https://charts.zitadel.com &&
helm repo update &&
helm upgrade --install zitadel zitadel/zitadel --values quickstart-values.yaml --wait
```

--------------------------------

### Build and run Spring Boot example with Maven

Source: https://zitadel.com/docs/examples/login/java-spring

Terminal commands to clone the example repository, build the project with Maven, and start the Spring Boot development server. After running, open http://localhost:3000 to test the login flow.

```bash
# 1. Clone the repository
git clone git@github.com:zitadel/example-auth-spring.git
cd example-auth-spring

# 2. Build the project and download dependencies
mvn clean install

# 3. Start the development server
mvn spring-boot:run
```

--------------------------------

### Download and Run Docker Compose Example

Source: https://zitadel.com/docs/self-hosting/manage/configure/configure

Commands to download the Docker Compose example configuration files, generate a 32-byte masterkey, and start the ZITADEL and database containers in detached mode. The masterkey must be the same across restarts.

```bash
# Download the docker compose example configuration.
wget https://raw.githubusercontent.com/zitadel/zitadel/main/apps/docs/content/self-hosting/manage/configure/docker-compose.yaml

# Download and adjust the example configuration file containing standard configuration.
wget https://raw.githubusercontent.com/zitadel/zitadel/main/apps/docs/content/self-hosting/manage/configure/example-zitadel-config.yaml

# Download and adjust the example configuration file containing secret configuration.
wget https://raw.githubusercontent.com/zitadel/zitadel/main/apps/docs/content/self-hosting/manage/configure/example-zitadel-secrets.yaml

# Download and adjust the example configuration file containing database initialization configuration.
wget https://raw.githubusercontent.com/zitadel/zitadel/main/apps/docs/content/self-hosting/manage/configure/example-zitadel-init-steps.yaml

# A single ZITADEL instance always needs the same 32 bytes long masterkey
# Generate one to a file if you haven't done so already and pass it as environment variable
LC_ALL=C tr -dc '[:graph:]' </dev/urandom | head -c 32 > ./zitadel-masterkey
export ZITADEL_MASTERKEY="$(cat ./zitadel-masterkey)"

# Run the database and application containers
docker compose up --detach
```

--------------------------------

### Run PostgreSQL

Source: https://zitadel.com/docs/self-hosting/deploy/macos

Initializes and starts a PostgreSQL instance in /tmp/postgresql. Requires a PostgreSQL binary installed.

```bash
sudo pg_ctl init -D /tmp/postgresql
sudo pg_ctl start -D /tmp/postgresql
```

--------------------------------

### Start TOTP Registration with POST /v2/users/$USER_ID/totp

Source: https://zitadel.com/docs/guides/integrate/login-ui/mfa

Use the POST /v2/users/$USER_ID/totp request to start TOTP registration. The response contains a URI for generating a QR code and a secret for manual setup.

```bash
curl --request POST \
    --url https://${CUSTOM_DOMAIN}/v2/users/$USER_ID/totp \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer '"$TOKEN"''
    --header 'Content-Type: application/json' \
    --data '{}'
```

```json
{
  "details": {
    "sequence": "2",
    "changeDate": "2023-06-28",
    "resourceOwner": "69629023906488334"
  },
  "uri": "otpauth://totp/ZITADEL:minni-mouse@mouse.com?algorithm=SHA1&digits=6&issuer=ZITADEL&period=30&secret=TJOPWSDYILLHXFV4MLKNNJOWFG7VSDCK",
  "secret": "TJOPWSDYILLHXFV4MLKNNJOWFG7VSDCK"
}
```

--------------------------------

### Run application with example values

Source: https://zitadel.com/docs/examples/login/go

Example command with sample values for domain, key, clientID, and redirectURI.

```bash
go run main.go --domain my-domain.zitadel.cloud --key XKv2Lqd7YAq13NUUWZEWZeruqyzM --clientID 243861627644836@example --redirectURI http://localhost:8089/auth/callback
```

--------------------------------

### Download, generate certificate, run and test Traefik TLS setup

Source: https://zitadel.com/docs/self-hosting/manage/reverseproxy/traefik

Commands to download the required configuration files, generate a self-signed certificate, start the database and Traefik, and test the gRPC and HTTP health endpoints. Requires grpcurl to be installed.

```bash
# Download the configuration files.
export ZITADEL_CONFIG_FILES=https://raw.githubusercontent.com/zitadel/zitadel/main/apps/docs/content/self-hosting/manage/reverseproxy
wget ${ZITADEL_CONFIG_FILES}/docker-compose.yaml -O docker-compose-base.yaml --quiet
wget ${ZITADEL_CONFIG_FILES}/traefik/docker-compose.yaml -O docker-compose-traefik.yaml --quiet
wget ${ZITADEL_CONFIG_FILES}/traefik/traefik-enabled-tls.yaml -O traefik-enabled-tls.yaml --quiet

# Generate a self signed certificate and key.
openssl req -x509 -batch -subj "/CN=127.0.0.1.sslip.io/O=Zitadel Demo" -nodes -newkey rsa:2048 -keyout ./selfsigned.key -out ./selfsigned.crt 2>/dev/null

# Run the database, and Traefik.
docker compose --file docker-compose-base.yaml --file docker-compose-traefik.yaml up --detach --wait db zitadel-init zitadel-enabled-tls login-enabled-tls proxy-enabled-tls

# Test that gRPC and HTTP APIs work. Empty brackets like {} means success.
# Make sure you have the grpcurl cli installed on your machine https://github.com/fullstorydev/grpcurl?tab=readme-ov-file#installation
grpcurl --insecure 127.0.0.1.sslip.io:443 zitadel.admin.v1.AdminService/Healthz
curl --insecure https://127.0.0.1.sslip.io:443/admin/v1/healthz
```

--------------------------------

### Get Active Identity Providers Response Example

Source: https://zitadel.com/docs/reference/api/settings/zitadel.settings.v2.SettingsService.GetActiveIdentityProviders

Example response body for the Get Active Identity Providers endpoint. Shows the structure with details and identityProviders array, including options for linking, creation, and auto-linking.

```json
{
  "details": {
    "totalResult": 0,
    "processedSequence": 0,
    "timestamp": "2023-01-15T01:30:15.01Z"
  },
  "identityProviders": [
    {
      "id": "string",
      "name": "string",
      "type": "IDENTITY_PROVIDER_TYPE_UNSPECIFIED",
      "options": {
        "isLinkingAllowed": true,
        "isCreationAllowed": true,
        "isAutoCreation": true,
        "isAutoUpdate": true,
        "autoLinking": "AUTO_LINKING_OPTION_UNSPECIFIED"
      }
    }
  ]
}
```

--------------------------------

### Get Auth Request by ID - Response

Source: https://zitadel.com/docs/guides/integrate/login-ui/oidc-standard

Example JSON response from the Get Auth Request by ID endpoint.

```json
{
	"authRequest": {
		"id": "V2_224908753244265546",
		"creationDate": "2023-07-28T13:47:43.471505Z",
		"clientId": "224901977648260028@mytestproject",
		"scope": [
			"openid",
			"profile"
		],
		"redirectUri": "https://myapp.example.com/auth/callback",
		"loginHint": "mini@mouse.com"
	}
}
```

--------------------------------

### Prepare destination database with zitadel init and setup

Source: https://zitadel.com/docs/self-hosting/manage/cli/mirror

Initializes and sets up the destination database without an instance, preparing it for mirroring.

```bash
zitadel init --config /path/to/your/new/config.yaml
zitadel setup --for-mirror --config /path/to/your/new/config.yaml # make sure to set --tlsMode and masterkey analog to your current deployment
```

--------------------------------

### Get SAML Request Response

Source: https://zitadel.com/docs/guides/integrate/login-ui/saml-standard

Example response from the Get SAML Request by ID endpoint, showing the SAML request details.

```json
{
  "samlRequest": {
    "id": "V2_224908753244265546",
    "creationDate": "2023-07-28T13:47:43.471505Z",
    "issuer": "https://myapp.example.com",
    "assertionConsumerService": "https://myapp.example.com/acs",
    "relayState": "CncN92gdF6is7bak63thXOsn0MmJn7CLQeGKWaXZo2L8nJN0sPEHbb4I",
    "binding": "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"
  }
}
```

--------------------------------

### Example run command

Source: https://zitadel.com/docs/guides/integrate/zitadel-apis/example-zitadel-api-with-go

Shows a concrete example of running the application with a specific domain and key file.

```bash
go run cli.go --domain my-domain.zitadel.cloud --key ./api.json
```

--------------------------------

### Download prodlike overlay and start with init/setup/API split

Source: https://zitadel.com/docs/self-hosting/deploy/compose

Downloads the prodlike overlay file and starts ZITADEL with the init/setup/API split. Creates three containers: zitadel-init (migrations), zitadel-setup (instance config), and zitadel-api (long-running API). Use for controlled upgrades where migrations run separately.

```bash
curl -fsSLO https://raw.githubusercontent.com/zitadel/zitadel/main/deploy/compose/docker-compose.prodlike.yml &&

docker compose --env-file .env \
  -f docker-compose.yml \
  -f docker-compose.prodlike.yml \
  up -d --wait
```

--------------------------------

### GET /v2/settings/hosted_login_translation

Source: https://zitadel.com/docs/reference/api/settings/zitadel.settings.v2.SettingsService.GetHostedLoginTranslation

This snippet documents the GET endpoint for retrieving hosted login translations. It includes the query parameters, request example, and response structure.

```APIDOC
## GET /v2/settings/hosted_login_translation

### Description
Returns the translations in the requested locale for the hosted login. The translations returned are based on the input level specified (system, instance or organization). If the requested level doesn't contain all translations, and ignore_inheritance is set to false, a merging process fallbacks onto the higher levels ensuring all keys in the file have a translation, which could be in the default language if the one of the locale is missing on all levels.

### Method
GET

### Endpoint
/v2/settings/hosted_login_translation

### Parameters
#### Query Parameters
- **system** (boolean) - Optional - Indicates the system level.
- **instance** (boolean) - Optional - Indicates the instance level.
- **organization_id** (string) - Optional - The organization ID for the organization level.
- **locale** (string) - Required - The locale of the translations to be returned. Needs to be a BCP 47 language tag (e.g. "en", "de", "fr-CH").
- **ignore_inheritance** (boolean) - Optional - If set to true, higher levels are ignored, if false higher levels are merged into the file.

### Request Example
```
curl -X GET "https://example.com/v2/settings/hosted_login_translation"
```

### Response
#### Success Response (200)
- **etag** (string) - The etag representing the hash of the translations as stored on DB. Reliable only if ignore_inheritance = true.
- **translations** (object) - The translations map.

#### Response Example
```
{
  "etag": "string",
  "translations": {
    "property1": null,
    "property2": null
  }
}
```
```

--------------------------------

### Start U2F registration response

Source: https://zitadel.com/docs/guides/integrate/login-ui/mfa

Example response from the start U2F registration request. Contains the publicKeyCredentialCreationOptions that must be passed to the browser's WebAuthN API.

```json
{
  "details": {
    "sequence": "2",
    "changeDate": "2023-07-03",
    "resourceOwner": "69629023906488334"
  },
  "u2fId": "163840776835432705",
  "publicKeyCredentialCreationOptions": {
    "publicKey": {
      "attestation": "none",
      "authenticatorSelection": {
        "userVerification": "required"
      },
      "challenge": "XaMYwWOZ5hj6pwtwJJlpcI-ExkO5TxevBMG4R8DoKQQ",
      "excludeCredentials": [
        {
          "id": "tVp1QfYhT8DkyEHVrv7blnpAo2YJzbZgZNBf7zPs6CI",
          "type": "public-key"
        }
      ],
      "pubKeyCredParams": [
        {
          "alg": -7,
          "type": "public-key"
        }
      ],
      "rp": {
        "id": "localhost",
        "name": "ZITADEL"
      },
      "timeout": 300000,
      "user": {
        "displayName": "Minie Mouse",
        "id": "MjE1NTk4MDAwNDY0OTk4OTQw",
        "name": "minie-mouse"
      }
    }
  }
}
```

--------------------------------

### Get Lockout Settings Response

Source: https://zitadel.com/docs/reference/api/settings/zitadel.settings.v2.SettingsService.GetLockoutSettings

Example response body for a successful GET request to `/v2/settings/lockout`. Shows the settings object with `maxPasswordAttempts`, `resourceOwnerType`, and `maxOtpAttempts` fields.

```json
{
  "details": {
    "sequence": 0,
    "changeDate": "2023-01-15T01:30:15.01Z",
    "resourceOwner": "string",
    "creationDate": "2023-01-15T01:30:15.01Z"
  },
  "settings": {
    "maxPasswordAttempts": 0,
    "resourceOwnerType": "RESOURCE_OWNER_TYPE_UNSPECIFIED",
    "maxOtpAttempts": 0
  }
}
```

--------------------------------

### Example .env file with placeholders

Source: https://zitadel.com/docs/examples/secure-api/python-django

Example .env file with placeholder values for the ZITADEL settings. Create this file in the root folder.

```text
ZITADEL_INTROSPECTION_URL = 'URL to the introspection endpoint to verify the provided token'
ZITADEL_DOMAIN = 'Domain used as audience in the token verification'
API_PRIVATE_KEY_FILE_PATH = 'Path to the key.json created in ZITADEL'
```

--------------------------------

### GET /v2/features/system

Source: https://zitadel.com/docs/reference/api/feature/zitadel.feature.v2.FeatureService.GetSystemFeatures

This snippet documents the GET /v2/features/system endpoint, which returns all configured features for the system. It includes the request example and the full response body structure.

```APIDOC
## GET /v2/features/system

### Description
Returns all configured features for the system. Unset fields mean the feature is the current system default.

### Method
GET

### Endpoint
/v2/features/system

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
curl -X GET "https://example.com/v2/features/system"
```

### Response
#### Success Response (200)
- **details** (object) - Contains sequence, changeDate, resourceOwner, and creationDate.
- **loginDefaultOrg** (object) - Contains enabled and source.
- **userSchema** (object) - Contains enabled and source.
- **oidcTokenExchange** (object) - Contains enabled and source.
- **improvedPerformance** (object) - Contains executionPaths and source.
- **oidcSingleV1SessionTermination** (object) - Contains enabled and source.
- **enableBackChannelLogout** (object) - Contains enabled and source.
- **loginV2** (object) - Contains required, baseUri, and source.
- **permissionCheckV2** (object) - Contains enabled and source.
- **enableRelationalTables** (object) - Contains enabled and source.

#### Response Example
```
{
  "details": {
    "sequence": 0,
    "changeDate": "2023-01-15T01:30:15.01Z",
    "resourceOwner": "string",
    "creationDate": "2023-01-15T01:30:15.01Z"
  },
  "loginDefaultOrg": {
    "enabled": true,
    "source": "SOURCE_UNSPECIFIED"
  },
  "userSchema": {
    "enabled": true,
    "source": "SOURCE_UNSPECIFIED"
  },
  "oidcTokenExchange": {
    "enabled": true,
    "source": "SOURCE_UNSPECIFIED"
  },
  "improvedPerformance": {
    "executionPaths": [
      "IMPROVED_PERFORMANCE_UNSPECIFIED"
    ],
    "source": "SOURCE_UNSPECIFIED"
  },
  "oidcSingleV1SessionTermination": {
    "enabled": true,
    "source": "SOURCE_UNSPECIFIED"
  },
  "enableBackChannelLogout": {
    "enabled": true,
    "source": "SOURCE_UNSPECIFIED"
  },
  "loginV2": {
    "required": true,
    "baseUri": "string",
    "source": "SOURCE_UNSPECIFIED"
  },
  "permissionCheckV2": {
    "enabled": true,
    "source": "SOURCE_UNSPECIFIED"
  },
  "enableRelationalTables": {
    "enabled": true,
    "source": "SOURCE_UNSPECIFIED"
  }
}
```
```

--------------------------------

### Configure ZITADEL by files with example YAML and start-from-init command

Source: https://zitadel.com/docs/self-hosting/manage/configure/configure

These files and commands are used to configure ZITADEL by files. The YAML files set standard, secret, and database initialization options. The shell commands download the example files, generate a 32-character masterkey, and start ZITADEL with the configuration files and masterkey.

```yaml
# All possible options and their defaults: https://github.com/zitadel/zitadel/blob/main/cmd/defaults.yaml
Log:
  Level: 'info'

# Make ZITADEL accessible over HTTP, not HTTPS
ExternalSecure: false

# If not using the docker compose example, adjust these values for connecting ZITADEL to your PostgreSQL
Database:
  postgres:
    Host: 'db'
    Port: 5432
    Database: zitadel
    User:
      SSL:
        Mode: 'disable'
    Admin:
      SSL:
        Mode: 'disable'

```

```yaml
# All possible options and their defaults: https://github.com/zitadel/zitadel/blob/main/cmd/defaults.yaml

# If not using the docker compose example, adjust these values for connecting ZITADEL to your PostgreSQL
Database:
  postgres:
    User:
      # If the user doesn't exist already, it is created
      Username: 'zitadel_user'
      Password: 'zitadel_pw'
    Admin:
      Username: 'root'
      Password: 'postgres'

```

```yaml
# All possible options and their defaults: https://github.com/zitadel/zitadel/blob/main/cmd/setup/steps.yaml
FirstInstance:
  Org:
    Human:
      # use the loginname root@zitadel.localhost
      Username: 'root'
      Password: 'RootPassword1!'

```

```bash
# Download and adjust the example configuration file containing standard configuration
wget https://raw.githubusercontent.com/zitadel/zitadel/main/apps/docs/content/self-hosting/manage/configure/example-zitadel-config.yaml

# Download and adjust the example configuration file containing secret configuration
wget https://raw.githubusercontent.com/zitadel/zitadel/main/apps/docs/content/self-hosting/manage/configure/example-zitadel-secrets.yaml

# Download and adjust the example configuration file containing database initialization configuration
wget https://raw.githubusercontent.com/zitadel/zitadel/main/apps/docs/content/self-hosting/manage/configure/example-zitadel-init-steps.yaml

# A single ZITADEL instance always needs the same 32 characters long masterkey
# If you haven't done so already, you can generate a new one
# The key must be passed as argument
ZITADEL_MASTERKEY="$(LC_ALL=C tr -dc '[:graph:]' </dev/urandom | head -c 32)"

# Pass zitadel configuration by configuration files
zitadel start-from-init \
    --config ./example-zitadel-config.yaml \
    --config ./example-zitadel-secrets.yaml \
    --steps ./example-zitadel-init-steps.yaml \
    --masterkey "${ZITADEL_MASTERKEY}"

```

--------------------------------

### Install dependencies and run Nuxt.js dev server

Source: https://zitadel.com/docs/sdk-examples/nuxtjs

Install dependencies and start the Nuxt.js development server. The application will be available at http://localhost:3000 for testing the authentication flow.

```bash
   npm install
   npm run dev
```

--------------------------------

### Create example application

Source: https://zitadel.com/docs/guides/integrate/zitadel-apis/example-zitadel-api-with-go

Creates a Go application that initializes the ZITADEL client with a service account key and calls the ManagementService's GetMyOrg function to retrieve organization details.

```go
package main

import (
	"context"
	"flag"
	"os"

	"github.com/zitadel/oidc/v3/pkg/oidc"
	"golang.org/x/exp/slog"

	"github.com/zitadel/zitadel-go/v3/pkg/client"
	"github.com/zitadel/zitadel-go/v3/pkg/client/zitadel/management"
	"github.com/zitadel/zitadel-go/v3/pkg/zitadel"
)

var (
	// flags to be provided for running the example server
	domain  = flag.String("domain", "", "your ZITADEL instance domain (in the form: <instance>.zitadel.cloud or <yourdomain>)")
	keyPath = flag.String("key", "", "path to your key.json")
)

func main() {
	flag.Parse()

	ctx := context.Background()

	// Initiate the API client by providing at least a zitadel configuration.
	// You can also directly set an authorization option, resp. provide its authentication mechanism,
	// by passing the downloaded service user key:
	api, err := client.New(ctx, zitadel.New(*domain),
		client.WithAuth(client.DefaultServiceUserAuthentication(*keyPath, oidc.ScopeOpenID, client.ScopeZitadelAPI())),
	)

	// In this example we will just use the ManagementService to retrieve the users organisation,
	// but you can use the API for all the other services (Admin, Auth, User, Session, ...) too.
	resp, err := api.ManagementService().GetMyOrg(ctx, &management.GetMyOrgRequest{})
	if err != nil {
		slog.Error("cannot retrieve the organisation", "error", err)
		os.Exit(1)
	}
	slog.Info("retrieved the organisation", "orgID", resp.GetOrg().GetId(), "name", resp.GetOrg().GetName())
}
```

--------------------------------

### 200 response for Get Password Expiry Settings

Source: https://zitadel.com/docs/reference/api/settings/zitadel.settings.v2.SettingsService.GetPasswordExpirySettings

Example 200 response body for the Get Password Expiry Settings endpoint. Shows the settings object with maxAgeDays, expireWarnDays, and resourceOwnerType fields.

```json
{
  "details": {
    "sequence": 0,
    "changeDate": "2023-01-15T01:30:15.01Z",
    "resourceOwner": "string",
    "creationDate": "2023-01-15T01:30:15.01Z"
  },
  "settings": {
    "maxAgeDays": 0,
    "expireWarnDays": 0,
    "resourceOwnerType": "RESOURCE_OWNER_TYPE_UNSPECIFIED"
  }
}
```

--------------------------------

### cURL GET request for hosted login translation

Source: https://zitadel.com/docs/reference/api/settings/zitadel.settings.v2.SettingsService.GetHostedLoginTranslation

Sends a GET request to the hosted login translation endpoint. The example uses the base URL https://example.com and the path /v2/settings/hosted_login_translation.

```cURL
curl -X GET "https://example.com/v2/settings/hosted_login_translation"
```

--------------------------------

### Clone Go example project

Source: https://zitadel.com/docs/guides/start/quickstart

Clones the ZITADEL Go example repository and navigates into the project directory.

```bash
git clone https://github.com/zitadel/zitadel-go.git
cd zitadel-go
```

--------------------------------

### Get Session Response Body

Source: https://zitadel.com/docs/reference/api/session/zitadel.session.v2.SessionService.GetSession

Example response body for a successful Get Session request. Contains session details including factors, metadata, user agent, and expiration date.

```json
{
  "session": {
    "id": "string",
    "creationDate": "2023-01-15T01:30:15.01Z",
    "changeDate": "2023-01-15T01:30:15.01Z",
    "sequence": 0,
    "factors": {
      "user": {
        "verifiedAt": "2023-01-15T01:30:15.01Z",
        "id": "string",
        "loginName": "string",
        "displayName": "string",
        "organizationId": "string"
      },
      "password": {
        "verifiedAt": "2023-01-15T01:30:15.01Z"
      },
      "webAuthN": {
        "verifiedAt": "2023-01-15T01:30:15.01Z",
        "userVerified": true
      },
      "intent": {
        "verifiedAt": "2023-01-15T01:30:15.01Z"
      },
      "totp": {
        "verifiedAt": "2023-01-15T01:30:15.01Z"
      },
      "otpSms": {
        "verifiedAt": "2023-01-15T01:30:15.01Z"
      },
      "otpEmail": {
        "verifiedAt": "2023-01-15T01:30:15.01Z"
      },
      "recoveryCode": {
        "verifiedAt": "2023-01-15T01:30:15.01Z"
      }
    },
    "metadata": {
      "property1": "string",
      "property2": "string"
    },
    "userAgent": {
      "fingerprintId": "string",
      "ip": "string",
      "description": "string",
      "header": {
        "property1": {
          "values": [
            "string"
          ]
        },
        "property2": {
          "values": [
            "string"
          ]
        }
      }
    },
    "expirationDate": "2023-01-15T01:30:15.01Z"
  }
}
```

--------------------------------

### GET /v2/idps/{id}

Source: https://zitadel.com/docs/reference/api/idp/zitadel.idp.v2.IdentityProviderService.GetIDPByID

This snippet documents the GET /v2/idps/{id} endpoint, which retrieves an identity provider by its ID. It includes the path parameter, request example, and the full response schema.

```APIDOC
## GET /v2/idps/{id}

### Description
Returns an identity provider (social/enterprise login) by its ID, which can be of the type Google, AzureAD, etc.

### Method
GET

### Endpoint
/v2/idps/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the identity provider.

### Request Example
```
curl -X GET "https://example.com/v2/idps/string"
```

### Response
#### Success Response (200)
- **idp** (object) - The identity provider object.
  - **id** (string) - The ID of the identity provider.
  - **details** (object) - Details about the identity provider.
    - **sequence** (integer) - The sequence number.
    - **changeDate** (string) - The change date.
    - **resourceOwner** (string) - The resource owner.
    - **creationDate** (string) - The creation date.
  - **state** (string) - The state of the identity provider.
  - **name** (string) - The name of the identity provider.
  - **type** (string) - The type of the identity provider.
  - **config** (object) - The configuration of the identity provider.
    - **options** (object) - Options for the identity provider.
      - **isLinkingAllowed** (boolean) - Whether linking is allowed.
      - **isCreationAllowed** (boolean) - Whether creation is allowed.
      - **isAutoCreation** (boolean) - Whether auto creation is allowed.
      - **isAutoUpdate** (boolean) - Whether auto update is allowed.
      - **autoLinking** (string) - The auto linking option.
    - **apple** (object) - Apple-specific configuration.
      - **clientId** (string) - The client ID.
      - **teamId** (string) - The team ID.
      - **keyId** (string) - The key ID.
      - **scopes** (array of strings) - The scopes.

#### Response Example
```
{
  "idp": {
    "id": "string",
    "details": {
      "sequence": 0,
      "changeDate": "2023-01-15T01:30:15.01Z",
      "resourceOwner": "string",
      "creationDate": "2023-01-15T01:30:15.01Z"
    },
    "state": "IDP_STATE_UNSPECIFIED",
    "name": "string",
    "type": "IDP_TYPE_UNSPECIFIED",
    "config": {
      "options": {
        "isLinkingAllowed": true,
        "isCreationAllowed": true,
        "isAutoCreation": true,
        "isAutoUpdate": true,
        "autoLinking": "AUTO_LINKING_OPTION_UNSPECIFIED"
      },
      "apple": {
        "clientId": "string",
        "teamId": "string",
        "keyId": "string",
        "scopes": [
          "string"
        ]
      }
    }
  }
}
```
```

--------------------------------

### Run the ZITADEL device client example with environment variables

Source: https://zitadel.com/docs/guides/integrate/login/oidc/device-authorization

Set the ISSUER and CLIENT_ID environment variables and run the Go device client example. The ISSUER must not have a trailing slash. The command uses the latest version of the example from the ZITADEL OIDC library.

```bash
ISSUER="https://test-0o6zvq.zitadel.cloud" \
CLIENT_ID="232685602728952637@device_auth" \
go run github.com/zitadel/oidc/v2/example/client/device@latest
```

--------------------------------

### ZITADEL Init Steps File (example-zitadel-init-steps.yaml)

Source: https://zitadel.com/docs/self-hosting/manage/configure/configure

Example ZITADEL initialization steps file (example-zitadel-init-steps.yaml) that defines the first instance's organization human user. The login name is root@zitadel.localhost and the password is RootPassword1!.

```yaml
# All possible options and their defaults: https://github.com/zitadel/zitadel/blob/main/cmd/setup/steps.yaml
FirstInstance:
  Org:
    Human:
      # use the loginname root@zitadel.localhost
      Username: 'root'
      Password: 'RootPassword1!'

```
Tokens:
Raw