Add Organization

Create a new organization with an administrative user. If no specific roles are sent for the users, they will be granted the role ORG_OWNER.

Required permission:

org.create

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Name is the unique name of the organization to be created. This must be unique across the instance.

admins?array<|>

Specify users to be assigned as organization admins. If no users are specified here, the organization will be created without any admin users. The organization can still be managed by any instance administrator. If no roles are specified for a user, they will be assigned the role ORG_OWNER.

organizationId?|

OrganizationID is the unique identifier of the organization. This field is optional. If omitted, the system will generate one, which is the recommended way. The generated ID will be returned in the response.

orgId?|Deprecated

Optionally, set a unique id for the organization. If omitted, the system will generate one, which is the recommended way. The generated ID will be returned in the response.

Deprecated: use 'organization_id' field instead. If both org_id and organization_id are set, organization_id will take precedence.

Response Body

`application/json`

curl -X POST "https://loading/v2/organizations" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{
  "details": {
    "sequence": 0,
    "changeDate": "2023-01-15T01:30:15.01Z",
    "resourceOwner": "string",
    "creationDate": "2023-01-15T01:30:15.01Z"
  },
  "organizationId": "string",
  "createdAdmins": [
    {
      "userId": "string",
      "emailCode": "string",
      "phoneCode": "string"
    }
  ]
}

Request Body

Response Body

200application/json

`application/json`