Endpoint
/api/v2/tenants/{orgId}/clients/search
Path Parameters
orgId
string

mspId defined for the tenant

Query Parameters
pageNo
integer

pageSize
integer

sortName
string

isDescendingOrder
boolean

queryString
string

Responses

OK

descendingOrder
boolean

nextPage
boolean

nextPageNo
integer

orderBy
string

pageNo
integer

pageSize
integer

previousPageNo
integer

results
array

results.activated
results.addOns
(Optional) Client specific addOns as provided by OPSRAMP on specific packages Viz "SMS and Voice", "Knowledgebase Management", "OS Service Start/Stop Actions", "Remote Access Management", "Process Automation", "Extended Data Retention", "Mask Resource Identity Management", "Event Enrichment".
results.address
Address of the client.
results.agentPolicies
results.allDevicesCount
results.channel
Channel ID. To get list of available channels, access the Get Channels API.
results.city
City name.
results.clientDetails
results.country
Name of the country. To view a list of countries, access the Get Countries API.
results.createdBy
results.createdTime
results.duoSecurity
results.enableCLIRecording
Set enableCLIRecording=true to enable CLI recording.
results.extOrgId
External organization ID.
results.internetSPDetails
results.lastUpdatedBy
results.lpiClient
results.mobileNumber
Mobile number of client.
results.mspId
results.nableClient
results.name
Name of the client.
results.ncareAgent
results.ncareDevsCount
results.networkArchitectures
results.noPolicyDevsCount
results.nocDetails
NOC details. To get the list of available NOCs, access the Get Tenant NOCs API.
results.packages
(Optional) Client specific Packages as provided by OPSRAMP i..e Hybrid Discovery and Monitoring", "Event and Incident Management", "Remediation and Automation".
results.passwordPolicy
results.phoneNumber
Phone number of client.
results.phoneNumberExt
Phone number extension.
results.rdp2swfState
A flag used that if rdp2swfState=true, converts remote console recordings to flash format.
results.resourceDecommission
A resource can be decommissioned if you do not wish to manage the resource anymore. A resource moved into decommissioned state is not re-managed. Provide resourceDecommission: true to enable the module for a client. If you do not provide any value, the default value is false.
results.saClient
results.serviceAccessDetails
(Optional) List of Alternate Access Details.
results.services
(Optional) List of channel services:
results.showCopyClipBoard
Show Copy to Clipboard.
results.state
State name.
results.timeZone
Country time zone. Opsramp supports a comprehensive list of timezones. Example: "timeZone": "America/Los_Angeles"
results.twoFactorAuthentication
results.uniqueId
results.updatedTime
results.whiteListedIps
IP whitelisting is a security feature often used for limiting and controlling access only to trusted users. IP whitelisting allows you to create lists of trusted IP addresses or IP ranges from which your users can access your domains. Example: IP addresses can be of the form [172.22.22.*] or a range [172.22.2.{0-50}]
results.zip
Zip code.
totalPages
integer

totalResults
integer

{
  "descendingOrder": true,
  "nextPage": false,
  "orderBy": "client.id",
  "pageNo": 1,
  "pageSize": 10,
  "previousPageNo": 0,
  "results": [
    {
      "activated": true,
      "createdBy": {
        "email": "escalationmails@opsramp.com",
        "firstName": "OpsRamp",
        "lastName": "Admin",
        "loginName": "superadmin"
      },
      "createdTime": "2016-08-18T06:52:24+0000",
      "id": 14,
      "lastUpdatedBy": {
        "email": "escalationmails@opsramp.com",
        "firstName": "OpsRamp",
        "lastName": "Admin",
        "loginName": "superadmin"
      },
      "name": "Brocade Services",
      "uniqueId": "client_14",
      "updatedTime": "2016-08-25T18:56:04+0000"
    },
    {
      "activated": true,
      "createdBy": {
        "email": "escalationmails@opsramp.com",
        "firstName": "OpsRamp",
        "lastName": "Admin",
        "loginName": "superadmin"
      },
      "createdTime": "2016-07-23T16:18:42+0000",
      "id": 9,
      "lastUpdatedBy": {
        "email": "escalationmails@opsramp.com",
        "firstName": "OpsRamp",
        "lastName": "Admin",
        "loginName": "superadmin"
      },
      "name": "Brocade Corp.",
      "uniqueId": "client_9",
      "updatedTime": "2016-07-23T16:18:42+0000"
    },
    {
      "activated": true,
      "createdBy": {
        "email": "escalationmails@opsramp.com",
        "firstName": "OpsRamp",
        "lastName": "Admin",
        "loginName": "superadmin"
      },
      "createdTime": "2016-07-23T16:17:12+0000",
      "id": 8,
      "lastUpdatedBy": {
        "email": "escalationmails@opsramp.com",
        "firstName": "OpsRamp",
        "lastName": "Admin",
        "loginName": "superadmin"
      },
      "name": "Brocade Lab",
      "uniqueId": "client_8",
      "updatedTime": "2016-08-29T12:05:08+0000"
    }
  ],
  "totalPages": 1,
  "totalResults": 3
}