Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zitadel Policies API

Manage login, password, and notification policies

Zitadel Policies API is one of 11 APIs that Zitadel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 13 JSON Schema definitions.

Tagged areas include Policies. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a GitHub repository, and 13 JSON Schemas.

This API exposes 3 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://{instance}.zitadel.cloud, https://{custom-domain}.

3 operations 2 paths 1 schemas 2 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Servers
https://{instance}.zitadel.cloud
https://{custom-domain}
Authentication
HTTP Bearer
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Zitadel Policies API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Policies 3

Manage login, password, and notification policies

GET
/management/v1/policies/login
Zitadel Get Login Policy
getLoginPolicy → 200
PUT
/management/v1/policies/login
Zitadel Update Login Policy
updateLoginPolicy body → 200
GET
/management/v1/policies/passwords/lockout
Zitadel Get Password Lockout Policy
getPasswordLockoutPolicy → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is LoginPolicy (13 properties). Each schema is shown below with its type and property counts.

LoginPolicy
object
13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zitadel-policies-api-openapi.yml Raw ↑

Other APIs Zitadel publishes across the network.

Zitadel Auth API
Zitadel Admin API
Zitadel OIDC / OAuth 2.0
Zitadel SAML API
Zitadel Applications API
Zitadel Identity Providers API
Zitadel Organizations API
Zitadel Projects API
Zitadel Roles API
Zitadel Users API