Skip to main content

Get Project By ID​

Returns a project owned by the organization (no granted projects). A Project is a vessel for different applications sharing the same role context.

Path Parameters
  • id string required
Header Parameters
  • x-zitadel-orgid string

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

Responses

A successful response.

Schema
  • project object
  • id string
  • 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
  • name string
  • state string

    Possible values: [PROJECT_STATE_UNSPECIFIED, PROJECT_STATE_ACTIVE, PROJECT_STATE_INACTIVE]

    Default value: PROJECT_STATE_UNSPECIFIED

    current state of the project

  • projectRoleAssertion describes if the roles of the user should be added to the token
  • projectRoleCheck ZITADEL checks if the user has at least one on this project
  • hasProjectCheck ZITADEL checks if the org of the user has permission for this project
  • privateLabelingSetting Defines from where the private labeling should be triggered

    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

Loading...