Setup Organization
POST/orgs/_setup
Create a new organization with an administrative user. If no specific roles are sent for the first user, the user will get the role ORG_OWNER.
Request​
- application/json
- application/grpc
- application/grpc-web+proto
Body
required
Request to set up an organization. User is required
org
object
required
Possible values: non-empty
and <= 200 characters
Possible values: <= 200 characters
ZITADEL generates a domain (
human
object
Possible values: non-empty
and <= 200 characters
profile
object
required
Possible values: non-empty
and <= 200 characters
Possible values: non-empty
and <= 200 characters
Possible values: <= 200 characters
Possible values: <= 200 characters
a user can set the display name if nothing is set ZITADEL computes "first_name last_name"
Possible values: <= 10 characters
language tag analog https://tools.ietf.org/html/rfc3066
Possible values: [GENDER_UNSPECIFIED
, GENDER_FEMALE
, GENDER_MALE
, GENDER_DIVERSE
]
Default value: GENDER_UNSPECIFIED
email
object
required
Possible values: non-empty
email address of the user. (spec: https://tools.ietf.org/html/rfc2822#section-3.4.1)
phone
object
Possible values: non-empty
and <= 50 characters
mobile phone number of the user. (use global pattern of spec https://tools.ietf.org/html/rfc3966)
the initial password of the user
Body
required
Request to set up an organization. User is required
org
object
required
Possible values: non-empty
and <= 200 characters
Possible values: <= 200 characters
ZITADEL generates a domain (
human
object
Possible values: non-empty
and <= 200 characters
profile
object
required
Possible values: non-empty
and <= 200 characters
Possible values: non-empty
and <= 200 characters
Possible values: <= 200 characters
Possible values: <= 200 characters
a user can set the display name if nothing is set ZITADEL computes "first_name last_name"
Possible values: <= 10 characters
language tag analog https://tools.ietf.org/html/rfc3066
Possible values: [GENDER_UNSPECIFIED
, GENDER_FEMALE
, GENDER_MALE
, GENDER_DIVERSE
]
Default value: GENDER_UNSPECIFIED
email
object
required
Possible values: non-empty
email address of the user. (spec: https://tools.ietf.org/html/rfc2822#section-3.4.1)
phone
object
Possible values: non-empty
and <= 50 characters
mobile phone number of the user. (use global pattern of spec https://tools.ietf.org/html/rfc3966)
the initial password of the user
Body
required
Request to set up an organization. User is required
org
object
required
Possible values: non-empty
and <= 200 characters
Possible values: <= 200 characters
ZITADEL generates a domain (
human
object
Possible values: non-empty
and <= 200 characters
profile
object
required
Possible values: non-empty
and <= 200 characters
Possible values: non-empty
and <= 200 characters
Possible values: <= 200 characters
Possible values: <= 200 characters
a user can set the display name if nothing is set ZITADEL computes "first_name last_name"
Possible values: <= 10 characters
language tag analog https://tools.ietf.org/html/rfc3066
Possible values: [GENDER_UNSPECIFIED
, GENDER_FEMALE
, GENDER_MALE
, GENDER_DIVERSE
]
Default value: GENDER_UNSPECIFIED
email
object
required
Possible values: non-empty
email address of the user. (spec: https://tools.ietf.org/html/rfc2822#section-3.4.1)
phone
object
Possible values: non-empty
and <= 50 characters
mobile phone number of the user. (use global pattern of spec https://tools.ietf.org/html/rfc3966)
the initial password of the user
Responses​
- 200
- 400
- 403
- 404
- default
org, user and user membership were created successfully
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
{
"details": {
"sequence": "2",
"creationDate": "2024-11-04T10:46:44.791Z",
"changeDate": "2024-11-04T10:46:44.791Z",
"resourceOwner": "69629023906488334"
},
"orgId": "string",
"userId": "string"
}
- Schema
- Example (from schema)
Schema
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
{
"details": {
"sequence": "2",
"creationDate": "2024-11-04T10:46:44.791Z",
"changeDate": "2024-11-04T10:46:44.791Z",
"resourceOwner": "69629023906488334"
},
"orgId": "string",
"userId": "string"
}
- Schema
- Example (from schema)
Schema
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
{
"details": {
"sequence": "2",
"creationDate": "2024-11-04T10:46:44.791Z",
"changeDate": "2024-11-04T10:46:44.791Z",
"resourceOwner": "69629023906488334"
},
"orgId": "string",
"userId": "string"
}
invalid org or user
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the user does not have permission to access the resource.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}