Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/zitadel/zitadel/llms.txt

Use this file to discover all available pages before exploring further.

Endpoint

PATCH /v2/projects/{project_id}

Description

Update an existing project. All fields are optional; only provided fields will be updated.

Required Permission

  • project.write

Path Parameters

project_id
string
required
The unique identifier of the project to be updated.Min Length: 1
Max Length: 200

Request Body

name
string
Updated name of the project. If omitted, the name will remain unchanged.Min Length: 1
Max Length: 200
projectRoleAssertion
boolean
Enable/disable role information in the user info endpoint. If omitted, the setting will remain unchanged.
authorizationRequired
boolean
Enable/disable authorization checks when logging in. If omitted, the setting will remain unchanged.
projectAccessRequired
boolean
Enable/disable organization access checks. If omitted, the setting will remain unchanged.
privateLabelingSetting
string
Update the private labeling setting. If omitted, the setting will remain unchanged.

Response

changeDate
timestamp
The timestamp of the change to the project.

Example Request

curl -X PATCH https://your-domain.zitadel.cloud/v2/projects/69629012906488334 \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Updated Project",
    "projectRoleAssertion": true
  }'

Example Response

{
  "changeDate": "2025-01-23T10:34:18.051Z"
}

Error Responses

  • 404 Not Found - Project not found
  • 400 Bad Request - Invalid request data
  • 403 Forbidden - Insufficient permissions