Create new organization

POST

/system/orgs

curl --request POST \
  --url https://example.com/api/v1/system/orgs \
  --header 'Content-Type: application/json' \
  --cookie grommunioAuthJwt=<grommunioAuthJwt> \
  --data '{ "name": "example", "description": "example", "domains": [ 1 ] }'

• Default deployment path

Authorizations

• JWTCookie

Parameters

Header Parameters

X-Csrf-Token

string

CSRF Token

Request Body

Media typeapplication/json

object

name

string

description

string

nullable

domains

List of domain IDs belonging to the organization

Array<integer>

Example^generated

{
  "name": "example",
  "description": "example",
  "domains": [
    1
  ]
}

Responses

201

Organization created

Media typeapplication/json

object

ID

Unique ID of the object

integer

name

string

description

string

nullable

domainCount

Number of domains in this organization

integer

domains

List of domains belonging to the organization

Array<object>

object

ID

Unique ID of the object

integer

domainname

string

displayname

string

Example^generated

{
  "name": "example",
  "description": "example",
  "domainCount": 1,
  "domains": [
    {
      "domainname": "example",
      "displayname": "example"
    }
  ]
}

400

Validation of input parameters failed

Media typeapplication/json

object

message

string

errors

List of errors encountered during validation

Array<string>

Example^generated

{
  "message": "example",
  "errors": [
    "example"
  ]
}

500

An error occurred while processing the request

Media typeapplication/json

object

message

String representation of the exception

string

Example^generated

{
  "message": "example"
}

503

The database query failed

Media typeapplication/json

object

message

Description of the error

string

Example^generated

{
  "message": "example"
}