This operation returns the details associated with an organization.
Request
Syntax
GET <webservice>/Organization/{organizationId} 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 Parameters
|
Name |
Description |
|---|---|
|
organizationId |
The organization ID for the organization. If the organization ID is not known, use the GET Organization API to retrieve it. The organization ID is the ID in the shortName element. |
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
|
Parameter |
Description |
Element |
|---|---|---|
|
serviceType |
The type of entity. The valid value is 5 for organizations. |
organization |
|
flags |
organization |
|
|
description |
The description of the organization. |
organization |
|
login |
organization |
|
|
enabled |
organization |
|
|
useSecureLdap |
Indicates whether LDAP authentication is used or not. Valid values are 0/1. |
organization |
|
connectName |
The name of the organization. |
organization |
|
port |
organization |
|
|
enable |
tppm |
|
|
tppmType |
tppm |
|
|
portNumber |
proxyInformation |
|
|
clientName |
proxyEntity |
|
|
clientId |
proxyEntity |
|
|
_type_ |
proxyEntity |
|
|
emailDomainNames |
The domain the tenant administrator belongs to. |
organization |
|
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 |
|
physicalDeviceCount |
organizationProperties |
|
|
authCode |
organizationProperties |
|
|
deviceCount |
The number of devices associated with the organization. |
organizationProperties |
|
orgCreationDateTime |
The date and time the organization was created. Valid values are UNIX-style timestamps (seconds since January 1, 1970). |
organizationProperties |
|
hypervisiorCount |
organizationProperties |
|
|
totalMachineCount |
organizationProperties |
|
|
enableAuthCodeGen |
organizationProperties |
|
|
miscMachineCount |
organizationProperties |
|
|
serverCount |
The number of servers associated with the organization. |
organizationProperties |
|
userCount |
The number of users associated with the organization. |
organizationProperties |
|
vmCount |
The number of virtual machines (VMs) associated with the organization. |
organizationProperties |
|
deniedNavItems |
CommCell level: The left pane navigation nodes that the user role (persona) cannot access. For a list of valid values, see Navigation Codes and Titles. |
globalSettings |
|
defaultLandingPage |
CommCell level: The landing page set for the user role (persona). |
globalSettings |
|
userRole |
CommCell level: The user role (persona) that the navigation preferences apply to. Valid values are:
|
globalSettings |
|
deniedNavItems |
Company level: The left pane navigation nodes that the user role (persona) cannot access. For a list of valid values, see Navigation Codes and Titles. |
companySettings |
|
defaultLandingPage |
Company level: The landing page set for the user role (persona). |
companySettings |
|
userRole |
Company level: The user role (persona) that the navigation preferences apply to. Valid values are:
|
companySettings |
|
fullName |
The first and last name of the tenant administrator. |
primaryContacts |
|
_type_ |
user |
|
|
userName |
The user name of the tenant administrator. |
user |
|
userId |
The system-generated ID assigned to the user (tenant administrator). |
user |
Examples
Sample Request
GET <webservice>/Organization/16 HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Sample Response
{ "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, "navSettings": { "companySettings": [ { "deniedNavItems": "", "defaultLandingPage": "/endpointDashboard", "userRole": 1 }, { "deniedNavItems": "", "defaultLandingPage": "/devices", "userRole": 2 } ], "globalSettings": [ { "deniedNavItems": "", "defaultLandingPage": "/endpointDashboard", "userRole": 0 }, { "deniedNavItems": "gettingStarted,replicationGroups,commCell,license,operationWindow,metricsReporting,snmp,plugin,accessControl,globalExceptions,maintenance,dataOptions,certificate,storagePool,storage,snapArray,mediaAgent", "defaultLandingPage": "/subscriptions", "userRole": 1 }, { "deniedNavItems": "gettingStarted,dashboard,sharepoint,profile,subscriptions,replicationGroups,replicationMonitor,triggeredAlerts,commCell,license,customization,navigationPreferences,emailTemplates,operationWindow,metricsReporting,snmp,plugin,accessControl,globalExceptions,maintenance,dataOptions,certificate,storagePool,storage,snapArray,mediaAgent,users,userGroups,roles,identityServers,nameServers", "defaultLandingPage": "/devices", "userRole": 2 }, { "deniedNavItems": "commCell,license,customization,navigationPreferences,emailTemplates,operationWindow,metricsReporting,snmp,plugin,accessControl,globalExceptions,maintenance,dataOptions,certificate,identityServers", "defaultLandingPage": "/users", "userRole": 3 }, { "deniedNavItems": "gettingStarted,dashboard,profile,subscriptions,replicationGroups,replicationMonitor,triggeredAlerts,commCell,clientGroupDetails,serverGroups,license,customization,navigationPreferences,emailTemplates,operationWindow,metricsReporting,snmp,plugin,accessControl,globalExceptions,maintenance,dataOptions,certificate,storagePool,storage,snapArray,mediaAgent,users,userGroups,roles,identityServers,nameServers", "defaultLandingPage": "/servers", "userRole": 4 } ] }, "primaryContacts": [ { "fullName": "testadmin", "user": { "_type_": 13, "userName": "testalias\\testmail2", "userId": 140 } } ] } }
}