Get Company Details (v1)

Newer Version Available

A newer version of this API is available with simplified payloads aligned with the UI.

This operation returns the details associated with a Company.

More Details

Path Parameters

• OrganizationId string required

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• organizationInfo object

  organization object

  serviceType integer

  flags integer

  description string

  login string

  enabled integer

  useSecureLdap integer

  connectName string

  port integer

  tppm object

  enable boolean

  tppmType integer

  proxyInformation object

  portNumber integer

  proxyEntity object

  clientName string

  clientId integer

  _type_ integer

  emailDomainNames string[]

  resourceProvider object

  domainName string

  id integer

  shortName object

  domainName string

  id integer

  organizationProperties object

  physicalDeviceCount integer

  authCode string

  deviceCount integer

  orgCreationDateTime integer

  hypervisiorCount integer

  totalMachineCount integer

  enableAuthCodeGen boolean

  miscMachineCount integer

  serverCount integer

  userCount integer

  vmCount integer

  primaryContacts object[]

  fullName string

  user object

  _type_ integer

  userName string

  userId integer

{
  "organizationInfo": {
    "organization": {
      "serviceType": 0,
      "flags": 0,
      "description": "string",
      "login": "string",
      "enabled": 0,
      "useSecureLdap": 0,
      "connectName": "string",
      "port": 0,
      "tppm": {
        "enable": true,
        "tppmType": 0,
        "proxyInformation": {
          "portNumber": 0,
          "proxyEntity": {
            "clientName": "string",
            "clientId": 0,
            "_type_": 0
          }
        }
      },
      "emailDomainNames": [
        "string"
      ],
      "resourceProvider": {
        "domainName": "string",
        "id": 0
      },
      "shortName": {
        "domainName": "string",
        "id": 0
      }
    },
    "organizationProperties": {
      "physicalDeviceCount": 0,
      "authCode": "string",
      "deviceCount": 0,
      "orgCreationDateTime": 0,
      "hypervisiorCount": 0,
      "totalMachineCount": 0,
      "enableAuthCodeGen": true,
      "miscMachineCount": 0,
      "serverCount": 0,
      "userCount": 0,
      "vmCount": 0,
      "primaryContacts": [
        {
          "fullName": "string",
          "user": {
            "_type_": 0,
            "userName": "string",
            "userId": 0
          }
        }
      ]
    }
  }
}

{
  "organizationInfo": {
    "organization": {
      "serviceType": 5,
      "flags": 0,
      "description": "test Company",
      "login": "",
      "enabled": 1,
      "useSecureLdap": 0,
      "connectName": "test Company",
      "port": 0,
      "tppm": {
        "enable": false,
        "tppmType": 4,
        "proxyInformation": {
          "portNumber": 0,
          "proxyEntity": {
            "clientName": "0",
            "clientId": 0,
            "_type_": 3
          }
        }
      },
      "emailDomainNames": [
        "mail.com"
      ],
      "resourceProvider": {
        "domainName": "Qinetix Commcell",
        "id": 0
      },
      "shortName": {
        "domainName": "testalias",
        "id": 16
      }
    },
    "organizationProperties": {
      "physicalDeviceCount": 0,
      "authCode": "",
      "deviceCount": 0,
      "orgCreationDateTime": 1507659390,
      "hypervisiorCount": 0,
      "totalMachineCount": 0,
      "enableAuthCodeGen": false,
      "miscMachineCount": 0,
      "serverCount": 0,
      "userCount": 1,
      "vmCount": 0,
      "primaryContacts": [
        {
          "fullName": "testadmin",
          "user": {
            "_type_": 13,
            "userName": "testalias\\testmail2",
            "userId": 140
          }
        }
      ]
    }
  }
}

Loading...