ZITADEL Docs
APIsCore ResourcesV2Project

Update Project

Update an existing project.

Required permission:

  • project.write
POST
/zitadel.project.v2.ProjectService/UpdateProject

Header Parameters

Connect-Protocol-Version*number

Define the version of the Connect protocol

Value in1
Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

projectId*string

ProjectID is the unique identifier of the project to be updated.

name?|

Name is used to update the name of the project. This field is optional. If omitted, the name will remain unchanged.

projectRoleAssertion?|

ProjectRoleAssertion is a setting that can be enabled to have role information included in the user info endpoint. It is also dependent on your application settings to include it in tokens and other types. If omitted, the setting will remain unchanged.

authorizationRequired?|

AuthorizationRequired is a boolean flag that can be enabled to check if a user has a role of this project assigned when logging into an application of this project. If omitted, the setting will remain unchanged.

projectAccessRequired?|

ProjectAccessRequired is a boolean flag that can be enabled to check if the organization of the user has a grant to this project. If omitted, the setting will remain unchanged.

privateLabelingSetting?|

PrivateLabelingSetting is a setting that defines which private labeling/branding should trigger when getting to a login of this project. If omitted, the setting will remain unchanged.

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/zitadel.project.v2.ProjectService/UpdateProject" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{    "projectId": "string"  }'
{
  "changeDate": "2023-01-15T01:30:15.01Z"
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Was this page helpful?

Remove Project Role

Remove Project Role: Removes the role from the project and on every resource it has a dependency. This includes project grants and user grants (role assignments). Required permission:

Update Project Grant

Update Project Grant: Change the roles of the project that is granted to another organization. The project grant will allow the granted organization to access the project and manage the authorizations for its users. Req...