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

mspId defined for the tenant

activated
boolean

addOns
array

(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".

address
string

Address of the client.

agentPolicies
array

agentPolicies.deviceCount
agentPolicies.id
agentPolicies.name
Name of the Agent Policy. Set enable=true to enable policies.
agentPolicies.policies
allDevicesCount
integer

channel
object

Channel ID. To get list of available channels, access the Get Channels API.

channel.id
channel.name
channel.timeZone
city
string

City name.

clientDetails
object

clientDetails.boughtServices
clientDetails.businessDayEnd
End of the business day. Represented in numbers. Example: 1-Sunday, 7-Saturday
clientDetails.businessDayStart
Start of the business day. Represented in numbers. Example: 2-Monday, 6-Friday
clientDetails.businessEndHour
End of the business hour. The format is 24-hour clock notation. Example: 16, 20
clientDetails.businessEndMin
End of the business minute.
clientDetails.businessStartHour
Start of the business hour. The format is 24-hour clock notation. Example: 02, 15
clientDetails.businessStartMin
Start of the business minute.
clientDetails.clientTechnologies
clientDetails.remoteAccess
Set as true to enable remote access module . Note: This feature is enabled for clients only if remote access module is enabled at partner level.
clientDetails.smsVoiceNotification
Set as true to receive SMS Voice Notification .
country
string

Name of the country. To view a list of countries, access the Get Countries API.

createdBy
object

createdBy.address
(Optional) User address.
createdBy.altEmail
createdBy.authType
createdBy.changePassword
createdBy.city
(Optional) City name.
createdBy.country
Country name. To get the list of countries, use Get Countries API.
createdBy.createdTime
createdBy.designation
(Optional) User designation.
createdBy.email
Email of the user. (Alert and report notifications are sent to the email address.)
createdBy.firstName
User first name.
createdBy.id
createdBy.lastName
User last name
createdBy.loginName
User login name.
createdBy.mobileNumber
(Optional) User mobile number.
createdBy.orgId
createdBy.organizationName
createdBy.password
Password must have a minimum of 7 characters with at least: - One number (0-9) - One special character (#,!, $,*) - One lowercase (a-z) - One uppercase (A-Z) character
createdBy.phoneNumber
(Optional) User phone number.
createdBy.profileImage
createdBy.roles
(Optional) Defines permission sets to user and user groups on devices and device groups. Assign roles to a user. See Search Roles API to get roles created under a partner or client.
createdBy.state
(Optional) State name.
createdBy.status
createdBy.timeZone
Time zone of the country. Use the Get Timezones API to get the list of timezones. Example: "timeZone": { "code": "EST"}
createdBy.updatedTime
createdBy.userAccountType
(Optional) User account type: - REGULAR - BUSINESS
createdBy.userGroupType
(Optional) Assign users to all user groups, or specific users groups. A user can also be an individual user, NOT being part of any user group. Supported Values: ALL, NONE - If a user should be part of all user groups, provide userGroupType: ALL - If a user should be part of a specific user group, provide user group name. Example:"userGroups": [{ "name": "Luminalto Admins" }] - If a user should NOT be part of any user group, provide userGroupType: NONE
createdBy.userGroups
(Optional) Assign users to specific user groups. Provide name of the user group.Use Search User Groups API to get details of user groups.
createdBy.userNotifications
(Optional) Email to which the alert and report notifications are sent.
createdBy.zip
(Optional) Zip code.
createdTime
string

duoSecurity
object

duoSecurity.apiHostName
enableCLIRecording
boolean

Set enableCLIRecording=true to enable CLI recording.

extOrgId
string

External organization ID.

internetSPDetails
object

internetSPDetails.circuitId
internetSPDetails.memberId
internetSPDetails.name
internetSPDetails.password
internetSPDetails.phone
internetSPDetails.plan
internetSPDetails.url
internetSPDetails.userName
lastUpdatedBy
object

lastUpdatedBy.address
(Optional) User address.
lastUpdatedBy.altEmail
lastUpdatedBy.authType
lastUpdatedBy.changePassword
lastUpdatedBy.city
(Optional) City name.
lastUpdatedBy.country
Country name. To get the list of countries, use Get Countries API.
lastUpdatedBy.createdTime
lastUpdatedBy.designation
(Optional) User designation.
lastUpdatedBy.email
Email of the user. (Alert and report notifications are sent to the email address.)
lastUpdatedBy.firstName
User first name.
lastUpdatedBy.id
lastUpdatedBy.lastName
User last name
lastUpdatedBy.loginName
User login name.
lastUpdatedBy.mobileNumber
(Optional) User mobile number.
lastUpdatedBy.orgId
lastUpdatedBy.organizationName
lastUpdatedBy.password
Password must have a minimum of 7 characters with at least: - One number (0-9) - One special character (#,!, $,*) - One lowercase (a-z) - One uppercase (A-Z) character
lastUpdatedBy.phoneNumber
(Optional) User phone number.
lastUpdatedBy.profileImage
lastUpdatedBy.roles
(Optional) Defines permission sets to user and user groups on devices and device groups. Assign roles to a user. See Search Roles API to get roles created under a partner or client.
lastUpdatedBy.state
(Optional) State name.
lastUpdatedBy.status
lastUpdatedBy.timeZone
Time zone of the country. Use the Get Timezones API to get the list of timezones. Example: "timeZone": { "code": "EST"}
lastUpdatedBy.updatedTime
lastUpdatedBy.userAccountType
(Optional) User account type: - REGULAR - BUSINESS
lastUpdatedBy.userGroupType
(Optional) Assign users to all user groups, or specific users groups. A user can also be an individual user, NOT being part of any user group. Supported Values: ALL, NONE - If a user should be part of all user groups, provide userGroupType: ALL - If a user should be part of a specific user group, provide user group name. Example:"userGroups": [{ "name": "Luminalto Admins" }] - If a user should NOT be part of any user group, provide userGroupType: NONE
lastUpdatedBy.userGroups
(Optional) Assign users to specific user groups. Provide name of the user group.Use Search User Groups API to get details of user groups.
lastUpdatedBy.userNotifications
(Optional) Email to which the alert and report notifications are sent.
lastUpdatedBy.zip
(Optional) Zip code.
lpiClient
boolean

mobileNumber
string

Mobile number of client.

mspId
string

nableClient
boolean

name
string

Name of the client.

ncareAgent
boolean

ncareDevsCount
integer

networkArchitectures
object

networkArchitectures.file
file converted to base64.
networkArchitectures.name
Name of the file.
noPolicyDevsCount
integer

nocDetails
object

NOC details. To get the list of available NOCs, access the Get Tenant NOCs API.

nocDetails.id
nocDetails.name
packages
array

(Optional) Client specific Packages as provided by OPSRAMP i..e Hybrid Discovery and Monitoring", "Event and Incident Management", "Remediation and Automation".

passwordPolicy
object

passwordPolicy.allowLastFourPasswords
passwordPolicy.changePasswordAtFirstLogin
passwordPolicy.defaultPolicy
passwordPolicy.enablePasswordConstraints
passwordPolicy.maxAttemptsToLockout
passwordPolicy.minPasswordLength
passwordPolicy.passwordValidity
phoneExtension
string

Phone number extension.

phoneNumber
string

Phone number of client.

rdp2swfState
boolean

A flag used that if rdp2swfState=true, converts remote console recordings to flash format.

resourceDecommission
boolean

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.

saClient
boolean

serviceAccessDetails
array

(Optional) List of Alternate Access Details.

serviceAccessDetails.hostedManager
serviceAccessDetails.technology
To get list of available technologies, use the `Get Alert Technologies` API.
services
array

(Optional) List of channel services:

services.id
Service ID.
services.technologies
List of technologies of the given service.
showCopyClipBoard
boolean

Show Copy to Clipboard.

state
string

State name.

timeZone
string

Country time zone. Opsramp supports a comprehensive list of timezones. Example: "timeZone": "America/Los_Angeles"

twoFactorAuthentication
boolean

uniqueId
string

updatedTime
string

whiteListedIps
string

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}]

zip
string

Zip code.

{
  "addOns": [
    "Alert Enrichment",
    "Knowledgebase Management"
  ],
  "address": "Parkway",
  "agentPolicies": [
    {
      "name": "Servers Policy",
      "policies": [
        {
          "enable": true,
          "name": "PatchManagement"
        },
        {
          "enable": true,
          "name": "sqlitedb"
        }
      ]
    },
    {
      "name": "Desktops Policy",
      "policies": [
        {
          "enable": true,
          "name": "PatchManagement"
        },
        {
          "enable": false,
          "name": "sqlitedb"
        }
      ]
    },
    {
      "name": "Agent Policy",
      "policies": [
        {
          "enable": false,
          "name": "PatchManagement"
        },
        {
          "enable": true,
          "name": "sqlitedb"
        }
      ]
    }
  ],
  "channel": {
    "id": 7
  },
  "city": "San Jose",
  "clientDetails": {
    "businessDayEnd": 6,
    "businessDayStart": 2,
    "businessEndHour": 20,
    "businessEndMin": 0,
    "businessStartHour": 10,
    "businessStartMin": 0,
    "internetSPDetails": [
      {
        "circuitId": "SP-01",
        "memberId": "MEM001215",
        "name": "SP Name",
        "phone": "408-555-2345",
        "plan": "Monthly",
        "url": "https://spname.net.org",
        "userName": "consumer001215x"
      },
      {
        "circuitId": "SP_1-01",
        "memberId": "MEM001216",
        "name": "SP_1 Name",
        "phone": "408-555-4567",
        "plan": "Yearly",
        "url": "https://sp1.net.org",
        "userName": "consumer001216x"
      }
    ],
    "networkArchitectures": [
      {
        "file": "iVBORw0KGgoAAAANSUhEUgAAAAQAAAAEAQMAAACTPww9AAAABlBMVEX///+up58H0gfvAAAAAXRSTlMAQObYZgAAABVJREFUeF4dwAENAAAAQDDRRbc5sgADiACBp7r5nAAAAABJRU5ErkJggg==",
        "name": "arch-1.png"
      },
      {
        "file": "iVBORw0KGgoAAAANSUhEUgAAAAQAAAAEAQMAAACTPww9AAAABlBMVEX///+up58H0gfvAAAAAXRSTlMAQObYZgAAABVJREFUeF4dwAENAAAAQDDRRbc5sgADiACBp7r5nAAAAABJRU5ErkJggg==",
        "name": "arch-2.png"
      }
    ],
    "remoteAccess": true,
    "serviceAccessDetails": [
      {
        "hostedManager": {
          "accessType": "SSH",
          "ipAddress": "192.168.56.121",
          "ipRange": "172.21.30.* - 172.21.32.*",
          "password": "change.me",
          "port": "8443",
          "userName": "superadmin"
        },
        "technology": {
          "id": "6"
        }
      },
      {
        "hostedManager": {
          "accessType": "RDP",
          "ipAddress": "192.168.56.121",
          "ipRange": "172.21.30.* - 172.21.32.*",
          "password": "change.me",
          "port": "8443",
          "userName": "superadmin"
        },
        "technology": {
          "id": "7"
        }
      }
    ],
    "services": [
      {
        "id": 1,
        "technologies": [
          {
            "id": "1"
          },
          {
            "id": "2"
          },
          {
            "id": "3"
          }
        ]
      }
    ],
    "smsVoiceNotification": false
  },
  "country": "USA",
  "enableCLIRecording": true,
  "extOrgId": "Ext1010",
  "mobileNumber": "646-222-3333",
  "name": "GEO Services",
  "nocDetails": {
    "id": 11
  },
  "packages": [
    "Hybrid Discovery and Monitoring",
    "Event and Incident Management",
    "Remediation and Automation"
  ],
  "phoneExtension": "+1",
  "phoneNumber": "408-555-1234",
  "rdp2swfState": true,
  "resourceDecommission": false,
  "showCopyClipBoard": true,
  "state": "California",
  "timeZone": "America/Los_Angeles",
  "whiteListedIps": "172.22.22.*,172.22.2.[0-50]",
  "zip": "95101"
}

Responses

OK

name
string

uniqueId
string

{
  "name": "GEO Services",
  "uniqueId": "client_69883"
}