Loading...

REST API - POST Organization

This operation creates an organization.

Request

Syntax

POST <webservice>/Organization HTTP/1.1
Host: <host name>
Accept: {application/xml | application/json}
Authtoken: <authentication token>
Content-type: application/json

<create_organization_template.json>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Headers

Name

Description

Host

The host name of the Web Server or Web Console used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Content-type

The media type contained in the request body.

Request Body

Download the JSON file required for this request: create_organization_template.json. The following table displays the parameters for the request body.

Parameter

Description

Element

planName

The name of the plan. The plans selected are the plans that the tenant administrator can choose from.

plan

planId

The system-generated ID assigned to the plan.

plan

connectName

The name of the organization.

organization

emailDomainNames

The domain the tenant administrator belongs to.

organization

domainName

The name of the organization.

shortName

primaryDomain

 

organizationProperties

fullName

The first and last name of the tenant administrator.

primaryContacts

email

The email address of the tenant administrator.

primaryContacts

emailTemplateId

The system-generated ID for the email template that is sent to the tenant administrators upon creation of the organization.

emailTemplate

sendEmail

If set to true, a welcome email is sent to the primary contact user.

Api_CreateOrganizationRequest

useSystemCreatedAdmin

Add this option with value 1, to assign a system created admin user account as the tenant administrator for the organization.

When assigned, you do not require to provide any other contact information for the tenant administrator. The organization will authenticate users to access the software using SAML, OKTA, or other authentication methods.

Api_CreateOrganizationRequest

Response

Response Parameters

Parameter

Description

Element

errorCode

The possible error codes.

Valid values are:

  • 0, successful completion.
  • 2, a failure.
  • a specific error code.

response

entity

Details about the organization such as the provider ID.

response

Examples

Sample Request

POST <webservice>/Organization HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/json


{
  "organizationInfo": {
    "planDetails": [
      {
        "plan": {
          "planName": "Laptop plan",
          "planId": 1
        }
      }
    ],
    "organization": {
      "connectName": "test Company3",
      "emailDomainNames": [
        "mail.com"
      ],
      "shortName": {
        "domainName": "testalias3"
      }
    },
    "organizationProperties": {
      "primaryDomain": "",
      "primaryContacts": [
        {
          "fullName": "testadmin",
          "email": "testmail3@mail.com"
        }
]
}
},
"emailTemplate": {
"emailTemplateId": 1
}
"sendEmail": false
}

Sample Response

{
  "processinginstructioninfo": {
   "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": {
    "errorCode": 0,
    "entity": {
      "srmReportSet": 0,
      "type": 0,
      "srmReportType": 0,
      "clientSidePackage": true,
      "GUID": "3146C5E7-F898-410D-8952-6D8B84BABBE5",
      "_type_": 61,
      "providerId": 18,
      "providerDomainName": "testalias4",
      "consumeLicense": true
    }
  }
}

Last modified: 6/9/2020 9:53:25 AM