Endpoint
/api/v2/tenants/{varId}/clients/{clientId}Gets client details.
Path Parameters
varIdstring
clientIdstring
Responses
OK
activatedboolean
addressstring
Address of the client.
agentPoliciesarray
Child Parameters
- agentPolicies.deviceCount
- agentPolicies.id
- agentPolicies.name
- Name of the Agent Policy. Set enable=true to enable policies.
- agentPolicies.policies
allDevicesCountinteger
channelobject
Channel ID. To get list of available channels, access the Get Channels API.
Child Parameters
- channel.id
- channel.name
- channel.timeZone
citystring
City name.
clientDetailsobject
Child Parameters
- 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 .
countrystring
Name of the country. To view a list of countries, access the Get Countries API.
createdByobject
Child Parameters
- 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.
createdTimestring
enableCLIRecordingboolean
Set enableCLIRecording=true to enable CLI recording.
extOrgIdstring
External organization ID.
internetSPDetailsobject
Child Parameters
- internetSPDetails.circuitId
- internetSPDetails.memberId
- internetSPDetails.name
- internetSPDetails.password
- internetSPDetails.phone
- internetSPDetails.plan
- internetSPDetails.url
- internetSPDetails.userName
lastUpdatedByobject
Child Parameters
- 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.
lpiClientboolean
mobileNumberstring
Mobile number of client.
mspIdstring
nableClientboolean
namestring
Name of the client.
ncareAgentboolean
ncareDevsCountinteger
networkArchitecturesobject
Child Parameters
- networkArchitectures.file
- file converted to base64.
- networkArchitectures.name
- Name of the file.
noPolicyDevsCountinteger
nocDetailsobject
NOC details. To get the list of available NOCs, access the Get Tenant NOCs API.
Child Parameters
- nocDetails.id
- nocDetails.name
passwordPolicyobject
Child Parameters
- passwordPolicy.allowLastFourPasswords
- passwordPolicy.changePasswordAtFirstLogin
- passwordPolicy.defaultPolicy
- passwordPolicy.enablePasswordConstraints
- passwordPolicy.maxAttemptsToLockout
- passwordPolicy.minPasswordLength
- passwordPolicy.passwordValidity
phoneNumberstring
Phone number of client.
phoneNumberExtstring
Phone number extension.
rdp2swfStateboolean
A flag used that if rdp2swfState=true, converts remote console recordings to flash format.
resourceDecommissionboolean
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.
saClientboolean
serviceAccessDetailsarray
(Optional) List of Alternate Access Details.
Child Parameters
- serviceAccessDetails.hostedManager
- serviceAccessDetails.technology
- To get list of available technologies, use the `Get Alert Technologies` API.
servicesarray
(Optional) List of channel services:
Child Parameters
- services.id
- Service ID.
- services.technologies
- List of technologies of the given service.
showCopyClipBoardboolean
Show Copy to Clipboard.
statestring
State name.
timeZonestring
Country time zone. Opsramp supports a comprehensive list of timezones. Example: "timeZone": "America/Los_Angeles"
twoFactorAuthenticationboolean
uniqueIdstring
updatedTimestring
whiteListedIpsstring
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}]
zipstring
Zip code.
{
"activated": true,
"address": "Madapur, Near Global edge school",
"agentPolicies": [
{
"deviceCount": 16,
"id": 6,
"name": "Desktops Policy",
"policies": [
{
"enable": true,
"id": 1,
"name": "PatchManagement"
},
{
"enable": false,
"id": 2,
"name": "uvnc"
},
{
"enable": false,
"id": 3,
"name": "ncaretrayicon"
},
{
"enable": false,
"id": 6,
"name": "VCareCoreModule"
},
{
"enable": false,
"id": 7,
"name": "sqlitedb"
}
]
},
{
"deviceCount": 33,
"id": 5,
"name": "Servers Policy",
"policies": [
{
"enable": true,
"id": 1,
"name": "PatchManagement"
},
{
"enable": false,
"id": 2,
"name": "uvnc"
},
{
"enable": true,
"id": 3,
"name": "ncaretrayicon"
},
{
"enable": false,
"id": 6,
"name": "VCareCoreModule"
},
{
"enable": false,
"id": 7,
"name": "sqlitedb"
}
]
}
],
"allDevicesCount": 50,
"channel": {
"id": 7,
"name": "Opsramp",
"timeZone": "GMT"
},
"city": "Hyderabad",
"clientDetails": {
"boughtServices": [
"Customer Services"
],
"businessDayEnd": 6,
"businessDayStart": 2,
"businessEndHour": 22,
"businessEndMin": 0,
"businessStartHour": 10,
"businessStartMin": 0,
"clientTechnologies": [
"OPSRAMP",
"Zabbix"
],
"remoteAccess": true
},
"country": "India",
"createdBy": {
"email": "escalationmails@opsramp.com",
"firstName": "Ops",
"lastName": "Admin",
"loginName": "superadmin"
},
"createdTime": "2016-07-23T16:17:12+0000",
"duoSecurity": {
"apiHostName": "https://api.opsramp.com"
},
"enableCLIRecording": true,
"extOrgId": "EXT10001",
"lastUpdatedBy": {
"email": "escalationmails@opsramp.com",
"firstName": "Ops",
"lastName": "Admin",
"loginName": "superadmin"
},
"lpiClient": false,
"mobileNumber": "5232324543",
"mspId": "msp_6",
"nableClient": false,
"name": "Brocade Lab",
"ncareAgent": false,
"ncareDevsCount": 5,
"noPolicyDevsCount": 0,
"nocDetails": {
"id": 2,
"name": "HYD NOC1"
},
"passwordPolicy": {
"allowLastFourPasswords": false,
"changePasswordAtFirstLogin": true,
"defaultPolicy": true,
"enablePasswordConstraints": true,
"maxAttemptsToLockout": 6,
"minPasswordLength": 7,
"passwordValidity": 90
},
"phoneNumber": "5232324543",
"rdp2swfState": true,
"saClient": true,
"showCopyClipBoard": true,
"state": "Telangana",
"timeZone": "Asia/Calcutta",
"twoFactorAuthentication": true,
"uniqueId": "client_8",
"updatedTime": "2016-08-29T12:05:08+0000",
"whiteListedIps": "172.22.22.*,172.22.2.[0-50]",
"zip": "500081"
}Endpoint
/api/v2/tenants/{varId}/clients/{clientId}Updates a client.
Path Parameters
varIdstring
clientIdstring
Responses
OK
activatedboolean
addressstring
Address of the client.
agentPoliciesarray
Child Parameters
- agentPolicies.deviceCount
- agentPolicies.id
- agentPolicies.name
- Name of the Agent Policy. Set enable=true to enable policies.
- agentPolicies.policies
allDevicesCountinteger
channelobject
Channel ID. To get list of available channels, access the Get Channels API.
Child Parameters
- channel.id
- channel.name
- channel.timeZone
citystring
City name.
clientDetailsobject
Child Parameters
- 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 .
countrystring
Name of the country. To view a list of countries, access the Get Countries API.
createdByobject
Child Parameters
- 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.
createdTimestring
enableCLIRecordingboolean
Set enableCLIRecording=true to enable CLI recording.
extOrgIdstring
External organization ID.
internetSPDetailsobject
Child Parameters
- internetSPDetails.circuitId
- internetSPDetails.memberId
- internetSPDetails.name
- internetSPDetails.password
- internetSPDetails.phone
- internetSPDetails.plan
- internetSPDetails.url
- internetSPDetails.userName
lastUpdatedByobject
Child Parameters
- 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.
lpiClientboolean
mobileNumberstring
Mobile number of client.
mspIdstring
nableClientboolean
namestring
Name of the client.
ncareAgentboolean
ncareDevsCountinteger
networkArchitecturesobject
Child Parameters
- networkArchitectures.file
- file converted to base64.
- networkArchitectures.name
- Name of the file.
noPolicyDevsCountinteger
nocDetailsobject
NOC details. To get the list of available NOCs, access the Get Tenant NOCs API.
Child Parameters
- nocDetails.id
- nocDetails.name
passwordPolicyobject
Child Parameters
- passwordPolicy.allowLastFourPasswords
- passwordPolicy.changePasswordAtFirstLogin
- passwordPolicy.defaultPolicy
- passwordPolicy.enablePasswordConstraints
- passwordPolicy.maxAttemptsToLockout
- passwordPolicy.minPasswordLength
- passwordPolicy.passwordValidity
phoneNumberstring
Phone number of client.
phoneNumberExtstring
Phone number extension.
rdp2swfStateboolean
A flag used that if rdp2swfState=true, converts remote console recordings to flash format.
resourceDecommissionboolean
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.
saClientboolean
serviceAccessDetailsarray
(Optional) List of Alternate Access Details.
Child Parameters
- serviceAccessDetails.hostedManager
- serviceAccessDetails.technology
- To get list of available technologies, use the `Get Alert Technologies` API.
servicesarray
(Optional) List of channel services:
Child Parameters
- services.id
- Service ID.
- services.technologies
- List of technologies of the given service.
showCopyClipBoardboolean
Show Copy to Clipboard.
statestring
State name.
timeZonestring
Country time zone. Opsramp supports a comprehensive list of timezones. Example: "timeZone": "America/Los_Angeles"
twoFactorAuthenticationboolean
uniqueIdstring
updatedTimestring
whiteListedIpsstring
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}]
zipstring
Zip code.
{
"address": "GEO Services, Parkway",
"agentPolicies": [
{
"id": 1,
"name": "Servers Policy",
"policies": [
{
"enable": true,
"name": "PatchManagement"
},
{
"enable": true,
"name": "sqlitedb"
}
]
},
{
"id": 2,
"name": "Desktops Policy",
"policies": [
{
"enable": true,
"name": "PatchManagement"
},
{
"enable": false,
"name": "sqlitedb"
}
]
},
{
"id": 3,
"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,
"remoteAccess": true,
"smsVoiceNotification": false
},
"country": "USA",
"enableCLIRecording": true,
"extOrgId": "Ext1010",
"mobileNumber": "646-222-3333",
"name": "GEO Services",
"nocDetails": {
"id": 11
},
"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"
}