Loading...

REST API - GET Organization

This operation returns a list of organizations.

Request

Syntax

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

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.

Response

Response Parameters

Name

Description

Elements

serviceType

The type of entity.

The valid value is 5 for organizations.

providers

flags

 

providers

description

The description of the organization.

providers

enabled

 

providers

bTrustedHostUser

 

providers

useSecureLdap

Indicates whether LDAP authentication is used or not.

Valid values are 0/1.

providers

connectName

The name of the organization.

providers

port

 

providers

bLogin

 

providers

enable

 

tppm

tppmType

 

tppm

portNumber

 

proxyInformation

clientName

 

proxyEntity

clientId

 

proxyEntity

_type_

 

proxyEntity

fullName

The first and last name of the tenant administrator.

primaryContacts

userName

The user name of the tenant administrator.

user

userId

The system-generated ID assigned to the user (tenant administrator).

user

domainName

The name of the organization domain.

resourceProvider

id

The system-generated ID assigned to the domain.

resourceProvider

domainName

The name of the organization.

shortName

id

The system-generated ID assigned to the organization.

shortName

Examples

Sample Request

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

Sample Response

{
  "providers": [
    {
      "serviceType": 5,
      "flags": 0,
      "description": "Company001",
      "enabled": 1,
      "bTrustedHostUser": "",
      "useSecureLdap": 0,
      "connectName": "Test Company",
      "port": 0,
      "bLogin": "",
      "tppm": {
        "enable": false,
        "tppmType": 4,
        "proxyInformation": {
          "portNumber": 0,
          "proxyEntity": {
            "clientName": "0",
            "clientId": 0,
            "_type_": 3
          }
        }
      },
      "primaryContacts": [
        {
          "fullName": "admin",
          "user": {
            "userName": "test\\testcompanyadmin",
            "userId": 130
          }
        }
      ],
      "resourceProvider": {
        "domainName": "Qinetix Commcell",
        "id": 0
      },
      "shortName": {
        "domainName": "test",
        "id": 6
      }
    }
  ]
}

Last modified: 2/27/2018 9:57:13 PM