Loading...

REST API - GET Identity Servers

This operation returns the details of SAML applications and domains in a CommCell environment. If you log in as a tenant user, then this operation returns the details of SAML applications and domains in the Company.

Request

Syntax

GET <webservice>/IdentityServers HTTP/1.1
Host: <host name>
Accept: application/xml
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.

Authtoken

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

Response

Response Parameters

Parameter

Description

Element

Parent Element

IdentityServerId

The ID representing the identity server.

IdentityServers

App_GetIdentityServersResponse

IdentityServerName

The name of the SAML application or NetBIOS domain name.

IdentityServers

App_GetIdentityServersResponse

domainName

The name of the domain configured for the identity server..

IdentityServers

App_GetIdentityServersResponse

isConfigured

Indicates whether or not the identity server is configured. Valid values are:

  • 1, is configured.
  • 0, is not configured.

IdentityServers

App_GetUserGroupPropertiesResponse

isEnabled

Indicates whether or not the identity server is enabled. Valid values are:

  • 1, is configured.
  • 0, is not configured.

IdentityServers

App_GetUserGroupPropertiesResponse

serviceType

The type of identity server, represented as an integer value.

IdentityServers

App_GetUserGroupPropertiesResponse

type

 

IdentityServers

App_GetUserGroupPropertiesResponse

domainName

The domain name of the company to which the identity server is associated.

ownerCompany

IdentityServers

id

The id representing the company to which the identity server is associated.

ownerCompany

IdentityServers

Examples

Sample Request

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

Sample Response

<?xml version="1.0" encoding="UTF-8"?>
<App_GetIdentityServersResponse>
  <identityServers IdentityServerId="15" IdentityServerName="IDServe3" domainName="example.company3.com" isConfigured="0" isEnabled="1" serviceType="12" type="2">
    <ownerCompany domainName="Company2" id="8" />
  </identityServers>
  <identityServers IdentityServerId="17" IdentityServerName="IDServe2" domainName="example.company2.com" isConfigured="1" isEnabled="1" serviceType="2" type="2">
    <ownerCompany domainName="Company2" id="3" />
  </identityServers>
  <identityServers IdentityServerId="20" IdentityServerName="IDServe3" domainName="example.company1.com" isConfigured="1" isEnabled="1" serviceType="2" type="2">
    <ownerCompany domainName="Company1 id="0" />
  </identityServers>
</App_GetIdentityServersResponse>

Last modified: 10/26/2018 2:56:13 PM