Creates a new instance with all needed setup data
This might take some time
Creates a new instance with all needed setup data This might take some time
- application/json
 - application/grpc
 - application/grpc-web+proto
 
Request Body required
- instanceName string
 - firstOrgName string
 - customDomain string
 human object
userName stringemail object
email stringisEmailVerified booleanprofile object
firstName stringlastName stringpreferredLanguage stringpassword object
password stringpasswordChangeRequired booleanmachine object
userName stringname stringpersonalAccessToken object
expirationDate date-timeThe date the token will expire and no logins will be possible
machineKey object
type stringPossible values: [
KEY_TYPE_UNSPECIFIED,KEY_TYPE_JSON]Default value:
KEY_TYPE_UNSPECIFIEDexpirationDate date-timeThe date the key will expire and no logins will be possible
- defaultLanguage string
 
Request Body required
- instanceName string
 - firstOrgName string
 - customDomain string
 human object
userName stringemail object
email stringisEmailVerified booleanprofile object
firstName stringlastName stringpreferredLanguage stringpassword object
password stringpasswordChangeRequired booleanmachine object
userName stringname stringpersonalAccessToken object
expirationDate date-timeThe date the token will expire and no logins will be possible
machineKey object
type stringPossible values: [
KEY_TYPE_UNSPECIFIED,KEY_TYPE_JSON]Default value:
KEY_TYPE_UNSPECIFIEDexpirationDate date-timeThe date the key will expire and no logins will be possible
- defaultLanguage string
 
Request Body required
- instanceName string
 - firstOrgName string
 - customDomain string
 human object
userName stringemail object
email stringisEmailVerified booleanprofile object
firstName stringlastName stringpreferredLanguage stringpassword object
password stringpasswordChangeRequired booleanmachine object
userName stringname stringpersonalAccessToken object
expirationDate date-timeThe date the token will expire and no logins will be possible
machineKey object
type stringPossible values: [
KEY_TYPE_UNSPECIFIED,KEY_TYPE_JSON]Default value:
KEY_TYPE_UNSPECIFIEDexpirationDate date-timeThe date the key will expire and no logins will be possible
- defaultLanguage string
 
- 200
 - 403
 - 404
 - default
 
A successful response.
- application/json
 - application/grpc
 - application/grpc-web+proto
 
- Schema
 - Example (from schema)
 
Schema
- instanceId 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- pat string
 - machineKey byte
 
{
  "instanceId": "string",
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-12",
    "changeDate": "2023-05-12",
    "resourceOwner": "69629023906488334"
  },
  "pat": "string",
  "machineKey": "string"
}
- Schema
 - Example (from schema)
 
Schema
- instanceId 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- pat string
 - machineKey byte
 
{
  "instanceId": "string",
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-12",
    "changeDate": "2023-05-12",
    "resourceOwner": "69629023906488334"
  },
  "pat": "string",
  "machineKey": "string"
}
- Schema
 - Example (from schema)
 
Schema
- instanceId 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- pat string
 - machineKey byte
 
{
  "instanceId": "string",
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-12",
    "changeDate": "2023-05-12",
    "resourceOwner": "69629023906488334"
  },
  "pat": "string",
  "machineKey": "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
- 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"
    }
  ]
}
Returned when the resource does not exist.
- 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"
    }
  ]
}
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"
    }
  ]
}