Skip to main content

Update Project

PUT 

/projects/:id

Update a project and its settings. A Project is a vessel for different applications sharing the same role context.

Request

Path Parameters

    id stringrequired

Header Parameters

    x-zitadel-orgid string

    The default is always the organization of the requesting user. If you like to change/get objects of another organization include the header. Make sure the requesting user has permission to access the requested data.

Body

required

    name stringrequired

    Possible values: non-empty and <= 200 characters

    projectRoleAssertion boolean

    Enable this setting 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.

    projectRoleCheck boolean

    When enabled ZITADEL will check if a user has a role of this project assigned when login into an application of this project.

    hasProjectCheck boolean

    When enabled ZITADEL will check if the organization of the user, that is trying to log in, has a grant to this project.

    privateLabelingSetting string

    Possible values: [PRIVATE_LABELING_SETTING_UNSPECIFIED, PRIVATE_LABELING_SETTING_ENFORCE_PROJECT_RESOURCE_OWNER_POLICY, PRIVATE_LABELING_SETTING_ALLOW_LOGIN_USER_RESOURCE_OWNER_POLICY]

    Default value: PRIVATE_LABELING_SETTING_UNSPECIFIED

    Define which private labeling/branding should trigger when getting to a login of this project.

Responses

A successful response.

Schema

    details

    object

    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

    resourceOwner resource_owner is the organization an object belongs to (string)
Loading...