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 Roles API

Manage project roles and role grants

Zitadel Roles 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 Roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a GitHub repository, and 13 JSON Schemas.

This API exposes 2 operations across 2 paths. 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}.

2 operations 2 paths 0 schemas 2 POST

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 Roles API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 2

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

Roles 2

Manage project roles and role grants

POST
/management/v1/projects/{projectId}/roles
Zitadel Create Project Role
createProjectRole 1 param body → 200
POST
/management/v1/projects/{projectId}/roles/_search
Zitadel List Project Roles
listProjectRoles 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zitadel-roles-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 Policies API
Zitadel Projects API
Zitadel Users API