Deprecated: Use CreateInstance instead

Creates a new instance with all needed setup data This might take some time

Deprecated: Use CreateInstance instead Creates a new instance with all needed setup data This might take some time

application/json

Request Body required

• instanceName string
• firstOrgName string
• customDomain string
• ownerUserName string
• ownerEmail object

  email string

  isEmailVerified boolean
• ownerProfile object

  firstName string

  lastName string

  preferredLanguage string
• ownerPassword object

  password string

  passwordChangeRequired boolean
• defaultLanguage string

application/grpc

Request Body required

• instanceName string
• firstOrgName string
• customDomain string
• ownerUserName string
• ownerEmail object

  email string

  isEmailVerified boolean
• ownerProfile object

  firstName string

  lastName string

  preferredLanguage string
• ownerPassword object

  password string

  passwordChangeRequired boolean
• defaultLanguage string

application/grpc-web+proto

Request Body required

• instanceName string
• firstOrgName string
• customDomain string
• ownerUserName string
• ownerEmail object

  email string

  isEmailVerified boolean
• ownerProfile object

  firstName string

  lastName string

  preferredLanguage string
• ownerPassword object

  password string

  passwordChangeRequired boolean
• defaultLanguage string

Responses

• 200
• 403
• 404
• default

---

A successful response.

application/json

• Schema
• Example (from schema)

---

Schema

• instanceId 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

{
  "instanceId": "string",
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-11",
    "changeDate": "2023-05-11",
    "resourceOwner": "69629023906488334"
  }
}

application/grpc

• Schema
• Example (from schema)

---

Schema

• instanceId 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

{
  "instanceId": "string",
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-11",
    "changeDate": "2023-05-11",
    "resourceOwner": "69629023906488334"
  }
}

application/grpc-web+proto

• Schema
• Example (from schema)

---

Schema

• instanceId 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

{
  "instanceId": "string",
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-11",
    "changeDate": "2023-05-11",
    "resourceOwner": "69629023906488334"
  }
}

Returned when the user does not have permission to access the resource.

application/json

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

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"
    }
  ]
}

Returned when the resource does not exist.

application/json

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

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"
    }
  ]
}

An unexpected error response.

application/json

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

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"
    }
  ]
}

POST /instances

Request

Base URL

https://$ZITADEL_DOMAIN/system/v1

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

Body required

{
  "instanceName": "string",
  "firstOrgName": "string",
  "customDomain": "string",
  "ownerUserName": "string",
  "ownerEmail": {
    "email": "string",
    "isEmailVerified": true
  },
  "ownerProfile": {
    "firstName": "string",
    "lastName": "string",
    "preferredLanguage": "string"
  },
  "ownerPassword": {
    "password": "string",
    "passwordChangeRequired": true
  },
  "defaultLanguage": "string"
}

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl -L -X POST 'https://$ZITADEL_DOMAIN/system/v1/instances' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "instanceName": "string",
  "firstOrgName": "string",
  "customDomain": "string",
  "ownerUserName": "string",
  "ownerEmail": {
    "email": "string",
    "isEmailVerified": true
  },
  "ownerProfile": {
    "firstName": "string",
    "lastName": "string",
    "preferredLanguage": "string"
  },
  "ownerPassword": {
    "password": "string",
    "passwordChangeRequired": true
  },
  "defaultLanguage": "string"
}'

curl -L -X POST 'https://$ZITADEL_DOMAIN/system/v1/instances' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "instanceName": "string",
  "firstOrgName": "string",
  "customDomain": "string",
  "ownerUserName": "string",
  "ownerEmail": {
    "email": "string",
    "isEmailVerified": true
  },
  "ownerProfile": {
    "firstName": "string",
    "lastName": "string",
    "preferredLanguage": "string"
  },
  "ownerPassword": {
    "password": "string",
    "passwordChangeRequired": true
  },
  "defaultLanguage": "string"
}'

curl -L -X POST 'https://$ZITADEL_DOMAIN/system/v1/instances' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "instanceName": "string",
  "firstOrgName": "string",
  "customDomain": "string",
  "ownerUserName": "string",
  "ownerEmail": {
    "email": "string",
    "isEmailVerified": true
  },
  "ownerProfile": {
    "firstName": "string",
    "lastName": "string",
    "preferredLanguage": "string"
  },
  "ownerPassword": {
    "password": "string",
    "passwordChangeRequired": true
  },
  "defaultLanguage": "string"
}'

curl -L -X POST 'https://$ZITADEL_DOMAIN/system/v1/instances' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "instanceName": "string",
  "firstOrgName": "string",
  "customDomain": "string",
  "ownerUserName": "string",
  "ownerEmail": {
    "email": "string",
    "isEmailVerified": true
  },
  "ownerProfile": {
    "firstName": "string",
    "lastName": "string",
    "preferredLanguage": "string"
  },
  "ownerPassword": {
    "password": "string",
    "passwordChangeRequired": true
  },
  "defaultLanguage": "string"
}'

curl -L -X POST 'https://$ZITADEL_DOMAIN/system/v1/instances' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "instanceName": "string",
  "firstOrgName": "string",
  "customDomain": "string",
  "ownerUserName": "string",
  "ownerEmail": {
    "email": "string",
    "isEmailVerified": true
  },
  "ownerProfile": {
    "firstName": "string",
    "lastName": "string",
    "preferredLanguage": "string"
  },
  "ownerPassword": {
    "password": "string",
    "passwordChangeRequired": true
  },
  "defaultLanguage": "string"
}'

curl -L -X POST 'https://$ZITADEL_DOMAIN/system/v1/instances' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "instanceName": "string",
  "firstOrgName": "string",
  "customDomain": "string",
  "ownerUserName": "string",
  "ownerEmail": {
    "email": "string",
    "isEmailVerified": true
  },
  "ownerProfile": {
    "firstName": "string",
    "lastName": "string",
    "preferredLanguage": "string"
  },
  "ownerPassword": {
    "password": "string",
    "passwordChangeRequired": true
  },
  "defaultLanguage": "string"
}'

curl -L -X POST 'https://$ZITADEL_DOMAIN/system/v1/instances' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "instanceName": "string",
  "firstOrgName": "string",
  "customDomain": "string",
  "ownerUserName": "string",
  "ownerEmail": {
    "email": "string",
    "isEmailVerified": true
  },
  "ownerProfile": {
    "firstName": "string",
    "lastName": "string",
    "preferredLanguage": "string"
  },
  "ownerPassword": {
    "password": "string",
    "passwordChangeRequired": true
  },
  "defaultLanguage": "string"
}'