Create Project
Create a new project. A Project is a vessel for different applications sharing the same role context.
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.
- application/json
- application/grpc
- application/grpc-web+proto
Request Body required
- name string required
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.
Request Body required
- name string required
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.
Request Body required
- name string required
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.
- 200
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- id string
details object
sequence uint64on 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-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to
{
"id": "98729028932384528",
"details": {
"sequence": "2",
"creationDate": "2023-05-02",
"changeDate": "2023-05-02",
"resourceOwner": "69629023906488334"
}
}
- Schema
- Example (from schema)
Schema
- id string
details object
sequence uint64on 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-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to
{
"id": "98729028932384528",
"details": {
"sequence": "2",
"creationDate": "2023-05-02",
"changeDate": "2023-05-02",
"resourceOwner": "69629023906488334"
}
}
- Schema
- Example (from schema)
Schema
- id string
details object
sequence uint64on 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-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to
{
"id": "98729028932384528",
"details": {
"sequence": "2",
"creationDate": "2023-05-02",
"changeDate": "2023-05-02",
"resourceOwner": "69629023906488334"
}
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}