Endpoint
/api/v2/tenants/{tenantId}/credentialSets

Gets a credential set.

Path Parameters
tenantId
string

Describes the clientId or mspId of the tenant

Query Parameters
pageNo
integer

pageSize
integer

sortName
string

isDescendingOrder
boolean

Responses

OK

descendingOrder
boolean

nextPage
boolean

nextPageNo
integer

orderBy
string

pageNo
integer

pageSize
integer

previousPageNo
integer

results
array

results.accountId
results.accountKey
results.accountName
results.apiEndPoint
results.assignedDeviceGroups
results.assignedDevices
results.assignedUsers
results.authProtocol
results.autoEnableMode
results.collectorType
Collector type.
results.community
results.credentialType
Credential type.
results.description
results.domainName
Domain name.
results.enablePassword
results.encryptPassword
results.esxPassword
results.esxUserName
results.fileAuthScope
results.managementCertificate
results.managementCertificatePassphrase
results.name
Credential set name.
results.password
Credentials of user.
results.port
results.secure
results.securityLevel
Security level.
results.securityName
results.snmpContext
results.snmpVersion
results.spAuthScope
results.spNameSpace
results.spPassword
results.spPort
results.spSecure
results.spUserName
results.sshCredentialType
SSH credential type.
results.syncDataTS
results.timeoutMs
Time out, represented in milliseconds.
results.transportType
Transport layer type.
results.uniqueId
results.universal
results.userName
Credentials of user.
totalPages
integer

totalResults
integer

{
  "descendingOrder": false,
  "nextPage": true,
  "nextPageNo": 2,
  "orderBy": "c.name",
  "pageNo": 1,
  "pageSize": 5,
  "previousPageNo": 0,
  "results": [
    {
      "autoEnableMode": false,
      "description": "Credentials to onboard AWS instance",
      "name": "AWS Instance Credentials",
      "port": 0,
      "secure": false,
      "snmpVersion": "V2",
      "spPort": 0,
      "spSecure": false,
      "timeoutMs": 15000,
      "uniqueId": "6bupAEC8NhxSHbsEnHJv6w7T",
      "universal": true
    },
    {
      "autoEnableMode": false,
      "description": "Credentials to onboard Azure instance",
      "name": "Azure Instance Credentials",
      "port": 440,
      "secure": true,
      "snmpVersion": "V2",
      "spPort": 0,
      "spSecure": false,
      "timeoutMs": 15000,
      "uniqueId": "cnTcDUueHt9sGKCyQFhm9JMV",
      "universal": true
    },
    {
      "autoEnableMode": false,
      "description": "Credentials to onboard Linux device",
      "id": 337,
      "name": "Linux Device Credentials",
      "port": 161,
      "secure": false,
      "snmpVersion": "V1",
      "spPort": 0,
      "spSecure": false,
      "timeoutMs": 15000,
      "uniqueId": "jpsMQpS2cZawQyBfHHqvZQ8u",
      "universal": true
    },
    {
      "autoEnableMode": false,
      "description": "Credentials to onboard Windows device",
      "id": 249,
      "name": "Windows Device Credenitals",
      "port": 0,
      "secure": false,
      "snmpVersion": "V2",
      "spPort": 0,
      "spSecure": false,
      "timeoutMs": 0,
      "uniqueId": "7ff95c99f747bedb4ac1c2f5",
      "universal": true
    },
    {
      "autoEnableMode": false,
      "description": "Credentials to onboard VMware device",
      "id": 301,
      "name": "VMware Credentials",
      "port": 5989,
      "secure": true,
      "snmpVersion": "V2",
      "spPort": 0,
      "spSecure": false,
      "timeoutMs": 15000,
      "uniqueId": "q76t5qr6zAhFeNyZJabcbj54",
      "universal": true
    }
  ],
  "totalPages": 2,
  "totalResults": 10
}
Endpoint
/api/v2/tenants/{tenantId}/credentialSets

Creates a credential set.

Path Parameters
tenantId
string

Describes the clientId or mspId of the tenant

accountId
string

accountKey
string

accountName
string

apiEndPoint
string

assignedDeviceGroups
array

assignedDeviceGroups.assignDevices
assignedDeviceGroups.client
assignedDeviceGroups.createdTime
assignedDeviceGroups.description
assignedDeviceGroups.deviceCount
assignedDeviceGroups.id
assignedDeviceGroups.name
assignedDeviceGroups.updatedTime
assignedDevices
array

assignedDevices.bios
assignedDevices.clientUniqueId
assignedDevices.generalInfo
assignedDevices.id
assignedDevices.ipAddress
assignedDevices.state
assignedDevices.status
assignedDevices.type
assignedDevices.uniqueId
assignedUsers
array

assignedUsers.address
User address.
assignedUsers.altEmail
assignedUsers.authType
assignedUsers.changePassword
assignedUsers.city
City name.
assignedUsers.country
Country name. To get the list of countries, use Get Countries API.
assignedUsers.createdTime
assignedUsers.designation
User designation.
assignedUsers.email
Email of the user. (Alert and report notifications are sent to the email address.)
assignedUsers.firstName
User first name.
assignedUsers.id
assignedUsers.lastName
User last name
assignedUsers.loginName
User login name.
assignedUsers.mobileNumber
User mobile number.
assignedUsers.orgId
assignedUsers.organizationName
assignedUsers.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
assignedUsers.phoneNumber
User phone number.
assignedUsers.profileImage
assignedUsers.roles
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.
assignedUsers.state
State name.
assignedUsers.status
assignedUsers.timeZone
Time zone of the country. Use the Get Timezones API to get the list of timezones.
assignedUsers.updatedTime
assignedUsers.userAccountType
User account type: - REGULAR - BUSINESS
assignedUsers.userGroupType
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
assignedUsers.userGroups
Assign users to specific user groups. Provide name of the user group.Use Search User Groups API to get details of user groups.
assignedUsers.userNotifications
Email to which the alert and report notifications are sent.
assignedUsers.zip
Zip code.
authProtocol
string

autoEnableMode
boolean

collectorType
string

Collector type.

community
string

credentialType
string

Credential type.

description
string

domainName
string

Domain name.

enablePassword
string

encryptPassword
string

esxPassword
string

esxUserName
string

fileAuthScope
string

managementCertificate
string

managementCertificatePassphrase
string

name
string

Credential set name.

password
string

Credentials of user.

port
integer

secure
boolean

securityLevel
string

Security level.

securityName
string

snmpContext
string

snmpVersion
string

spAuthScope
string

spNameSpace
string

spPassword
string

spPort
integer

spSecure
boolean

spUserName
string

sshCredentialType
string

SSH credential type.

syncDataTS
integer

timeoutMs
integer

Time out, represented in milliseconds.

transportType
string

Transport layer type.

uniqueId
string

universal
boolean

userName
string

Credentials of user.

{
  "accountId": "John@superadmin",
  "accountKey": "PASSWORD",
  "accountName": "12345",
  "assignedDeviceGroups": [
    {
      "id": "1665"
    },
    {
      "id": "1790"
    }
  ],
  "assignedDevices": [
    {
      "uniqueId": "DEV0000016029"
    },
    {
      "uniqueId": "DEV0000015402"
    }
  ],
  "credentialType": "AWS",
  "description": "TESTING FROM API",
  "name": "01. CREATE CREDENTIAL",
  "timeoutMs": 1500
}

Responses

OK

accountId
string

accountKey
string

accountName
string

apiEndPoint
string

assignedDeviceGroups
array

assignedDeviceGroups.assignDevices
assignedDeviceGroups.client
assignedDeviceGroups.createdTime
assignedDeviceGroups.description
assignedDeviceGroups.deviceCount
assignedDeviceGroups.id
assignedDeviceGroups.name
assignedDeviceGroups.updatedTime
assignedDevices
array

assignedDevices.bios
assignedDevices.clientUniqueId
assignedDevices.generalInfo
assignedDevices.id
assignedDevices.ipAddress
assignedDevices.state
assignedDevices.status
assignedDevices.type
assignedDevices.uniqueId
assignedUsers
array

assignedUsers.address
User address.
assignedUsers.altEmail
assignedUsers.authType
assignedUsers.changePassword
assignedUsers.city
City name.
assignedUsers.country
Country name. To get the list of countries, use Get Countries API.
assignedUsers.createdTime
assignedUsers.designation
User designation.
assignedUsers.email
Email of the user. (Alert and report notifications are sent to the email address.)
assignedUsers.firstName
User first name.
assignedUsers.id
assignedUsers.lastName
User last name
assignedUsers.loginName
User login name.
assignedUsers.mobileNumber
User mobile number.
assignedUsers.orgId
assignedUsers.organizationName
assignedUsers.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
assignedUsers.phoneNumber
User phone number.
assignedUsers.profileImage
assignedUsers.roles
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.
assignedUsers.state
State name.
assignedUsers.status
assignedUsers.timeZone
Time zone of the country. Use the Get Timezones API to get the list of timezones.
assignedUsers.updatedTime
assignedUsers.userAccountType
User account type: - REGULAR - BUSINESS
assignedUsers.userGroupType
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
assignedUsers.userGroups
Assign users to specific user groups. Provide name of the user group.Use Search User Groups API to get details of user groups.
assignedUsers.userNotifications
Email to which the alert and report notifications are sent.
assignedUsers.zip
Zip code.
authProtocol
string

autoEnableMode
boolean

collectorType
string

Collector type.

community
string

credentialType
string

Credential type.

description
string

domainName
string

Domain name.

enablePassword
string

encryptPassword
string

esxPassword
string

esxUserName
string

fileAuthScope
string

managementCertificate
string

managementCertificatePassphrase
string

name
string

Credential set name.

password
string

Credentials of user.

port
integer

secure
boolean

securityLevel
string

Security level.

securityName
string

snmpContext
string

snmpVersion
string

spAuthScope
string

spNameSpace
string

spPassword
string

spPort
integer

spSecure
boolean

spUserName
string

sshCredentialType
string

SSH credential type.

syncDataTS
integer

timeoutMs
integer

Time out, represented in milliseconds.

transportType
string

Transport layer type.

uniqueId
string

universal
boolean

userName
string

Credentials of user.

{
  "assignedAcls": [],
  "assignedDeviceGroups": [],
  "assignedDevices": [],
  "assignedUsers": [],
  "autoEnableMode": false,
  "name": "01. CREATE CREDENTIAL",
  "port": 0,
  "secure": false,
  "snmpVersion": "V2",
  "spPort": 0,
  "spSecure": false,
  "timeoutMs": 0,
  "uniqueId": "6rHBKNjsQcJM5ssqZ7NhmZsp",
  "universal": true
}