Get Identity Servers

Get identity servers list

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• identityServers object[]

  Identity servers list

  id int32

  Identity server id

  name string

  Identity server name

  appKey string

  Identity server appkey

  type string

  Possible values: [SAML, ACTIVE_DIRECTORY, APPLE_DIRECTORY_SERVICE, ORACLE_DIRECTORY, OPEN_LDAP, LDAP_SERVER, OPENIDCONNECT, OTHER]

  Identity server service type in Enum string

  samlType string

  Possible values: [UNKNOWN, AZURE, ADFS, OKTA]

  Name of the IdP. Available only if type is SAML.

  company object

  id int32

  name string

  configured boolean

  Boolean to indicate whether Identity server is configured.

  globalConfigInfo object

  Only applicable on Global CommCells

  id string

  name string

  commcells object[]

  List of Service CommCells where the global configuration is applied

  id int32

  name string

  guid string

  displayName string

  companies object[]

  List of companies where the global configuration is applied

  id int32

  name string

  guid string

  deploymentType string

  Possible values: [ON_PREM, SAAS, HYBRID]

  Defines where config is deployed.

  scope string

  The entity level at which the config is applied.

  scopeFilterQuery string

  CommCellEntityCache filter query string used for filtering the scope

  applyOnAllCommCells boolean

  Decides whether the global configuration should be applied to all the Service commcells, including the newly created ones

  applyOnAllOnPremCommCells boolean

  Decides whether the global configuration should be applied to all the On Prem Service commcells, including the newly created ones

  applyOnAllSaasCommCells boolean

  Decides whether the global configuration should be applied to all the SaaS Service commcells, including the newly created ones

  applyOnAllCompanies boolean

  Decides whether the global configuration should be applied to all the companies, including the newly created ones

  isMarkedForDeletion boolean

  Indicates whether global configuration deletion has been started.

  status string

  targetCommCellType string

  Possible values: [GLOBAL_COMMCELL, SERVICE_COMMCELL]

  Indicates the type of CommCell where the global configuration is targeted.

{
  "identityServers": [
    {
      "id": 0,
      "name": "string",
      "appKey": "string",
      "type": "SAML",
      "samlType": "UNKNOWN",
      "company": {
        "id": 0,
        "name": "string"
      },
      "configured": true,
      "globalConfigInfo": {
        "id": "string",
        "name": "string",
        "commcells": [
          {
            "id": 0,
            "name": "string",
            "guid": "string",
            "displayName": "string"
          }
        ],
        "companies": [
          {
            "id": 0,
            "name": "string",
            "guid": "string"
          }
        ],
        "deploymentType": "ON_PREM",
        "scope": "string",
        "scopeFilterQuery": "string",
        "applyOnAllCommCells": true,
        "applyOnAllOnPremCommCells": true,
        "applyOnAllSaasCommCells": true,
        "applyOnAllCompanies": true,
        "isMarkedForDeletion": true,
        "status": "string",
        "targetCommCellType": "GLOBAL_COMMCELL"
      }
    }
  ]
}

Loading...