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

POST 
/instances/_create

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

Request

application/json

Body

required

instanceName string
firstOrgName string
customDomain string

human

object

userName string

email

object

email string

isEmailVerified boolean

profile

object

firstName string

lastName string

preferredLanguage string

password

object

password string

passwordChangeRequired boolean

machine

object

userName string

name string

personalAccessToken

object

expirationDate date-time

The date the token will expire and no logins will be possible

machineKey

object

type string

Possible values: [KEY_TYPE_UNSPECIFIED, KEY_TYPE_JSON]

Default value: KEY_TYPE_UNSPECIFIED

expirationDate date-time

The date the key will expire and no logins will be possible

defaultLanguage string

application/grpc

Body

required

instanceName string
firstOrgName string
customDomain string

human

object

userName string

email

object

email string

isEmailVerified boolean

profile

object

firstName string

lastName string

preferredLanguage string

password

object

password string

passwordChangeRequired boolean

machine

object

userName string

name string

personalAccessToken

object

expirationDate date-time

The date the token will expire and no logins will be possible

machineKey

object

type string

Possible values: [KEY_TYPE_UNSPECIFIED, KEY_TYPE_JSON]

Default value: KEY_TYPE_UNSPECIFIED

expirationDate date-time

The date the key will expire and no logins will be possible

defaultLanguage string

application/grpc-web+proto

Body

required

instanceName string
firstOrgName string
customDomain string

human

object

userName string

email

object

email string

isEmailVerified boolean

profile

object

firstName string

lastName string

preferredLanguage string

password

object

password string

passwordChangeRequired boolean

machine

object

userName string

name string

personalAccessToken

object

expirationDate date-time

The date the token will expire and no logins will be possible

machineKey

object

type string

Possible values: [KEY_TYPE_UNSPECIFIED, KEY_TYPE_JSON]

Default value: KEY_TYPE_UNSPECIFIED

expirationDate date-time

The date the key will expire and no logins will be possible

defaultLanguage string

Responses

200

A successful response.

application/json

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 (string)
pat string
machineKey byte

Example (from schema)

{
  "instanceId": "string",
  "details": {
    "sequence": "2",
    "creationDate": "2024-12-23T07:03:23.296Z",
    "changeDate": "2024-12-23T07:03:23.297Z",
    "resourceOwner": "69629023906488334"
  },
  "pat": "string",
  "machineKey": "string"
}

application/grpc

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 (string)
pat string
machineKey byte

Example (from schema)

{
  "instanceId": "string",
  "details": {
    "sequence": "2",
    "creationDate": "2024-12-23T07:03:23.297Z",
    "changeDate": "2024-12-23T07:03:23.297Z",
    "resourceOwner": "69629023906488334"
  },
  "pat": "string",
  "machineKey": "string"
}

application/grpc-web+proto

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 (string)
pat string
machineKey byte

Example (from schema)

{
  "instanceId": "string",
  "details": {
    "sequence": "2",
    "creationDate": "2024-12-23T07:03:23.297Z",
    "changeDate": "2024-12-23T07:03:23.297Z",
    "resourceOwner": "69629023906488334"
  },
  "pat": "string",
  "machineKey": "string"
}

403

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

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

404

Returned when the resource does not exist.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

Loading...