Endpoint
/api/v2/tenants/{tenantId}/credentialSetsGets a credential set.
Path Parameters
tenantIdstring
Query Parameters
pageNointeger
pageSizeinteger
sortNamestring
isDescendingOrderboolean
Responses
OK
descendingOrderboolean
nextPageboolean
nextPageNointeger
orderBystring
pageNointeger
pageSizeinteger
previousPageNointeger
resultsarray
Child Parameters
- 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.
totalPagesinteger
totalResultsinteger
{
"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}/credentialSetsCreates a credential set.
Path Parameters
tenantIdstring
accountIdstring
accountKeystring
accountNamestring
apiEndPointstring
assignedDeviceGroupsarray
Child Parameters
- assignedDeviceGroups.assignDevices
- assignedDeviceGroups.client
- assignedDeviceGroups.createdTime
- assignedDeviceGroups.description
- assignedDeviceGroups.deviceCount
- assignedDeviceGroups.id
- assignedDeviceGroups.name
- assignedDeviceGroups.updatedTime
assignedDevicesarray
Child Parameters
- assignedDevices.bios
- assignedDevices.clientUniqueId
- assignedDevices.generalInfo
- assignedDevices.id
- assignedDevices.ipAddress
- assignedDevices.state
- assignedDevices.status
- assignedDevices.type
- assignedDevices.uniqueId
assignedUsersarray
Child Parameters
- assignedUsers.address
- (Optional) User address.
- assignedUsers.altEmail
- assignedUsers.authType
- assignedUsers.changePassword
- assignedUsers.city
- (Optional) City name.
- assignedUsers.country
- Country name. To get the list of countries, use Get Countries API.
- assignedUsers.createdTime
- assignedUsers.designation
- (Optional) 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
- (Optional) 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
- (Optional) User phone number.
- assignedUsers.profileImage
- assignedUsers.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.
- assignedUsers.state
- (Optional) State name.
- assignedUsers.status
- assignedUsers.timeZone
- Time zone of the country. Use the Get Timezones API to get the list of timezones. Example: "timeZone": { "code": "EST"}
- assignedUsers.updatedTime
- assignedUsers.userAccountType
- (Optional) User account type: - REGULAR - BUSINESS
- assignedUsers.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
- assignedUsers.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.
- assignedUsers.userNotifications
- (Optional) Email to which the alert and report notifications are sent.
- assignedUsers.zip
- (Optional) Zip code.
authProtocolstring
autoEnableModeboolean
collectorTypestring
Collector type.
communitystring
credentialTypestring
Credential type.
descriptionstring
domainNamestring
Domain name.
enablePasswordstring
encryptPasswordstring
esxPasswordstring
esxUserNamestring
fileAuthScopestring
managementCertificatestring
managementCertificatePassphrasestring
namestring
Credential set name.
passwordstring
Credentials of user.
portinteger
secureboolean
securityLevelstring
Security level.
securityNamestring
snmpContextstring
snmpVersionstring
spAuthScopestring
spNameSpacestring
spPasswordstring
spPortinteger
spSecureboolean
spUserNamestring
sshCredentialTypestring
SSH credential type.
syncDataTSinteger
timeoutMsinteger
Time out, represented in milliseconds.
transportTypestring
Transport layer type.
uniqueIdstring
universalboolean
userNamestring
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
accountIdstring
accountKeystring
accountNamestring
apiEndPointstring
assignedDeviceGroupsarray
Child Parameters
- assignedDeviceGroups.assignDevices
- assignedDeviceGroups.client
- assignedDeviceGroups.createdTime
- assignedDeviceGroups.description
- assignedDeviceGroups.deviceCount
- assignedDeviceGroups.id
- assignedDeviceGroups.name
- assignedDeviceGroups.updatedTime
assignedDevicesarray
Child Parameters
- assignedDevices.bios
- assignedDevices.clientUniqueId
- assignedDevices.generalInfo
- assignedDevices.id
- assignedDevices.ipAddress
- assignedDevices.state
- assignedDevices.status
- assignedDevices.type
- assignedDevices.uniqueId
assignedUsersarray
Child Parameters
- assignedUsers.address
- (Optional) User address.
- assignedUsers.altEmail
- assignedUsers.authType
- assignedUsers.changePassword
- assignedUsers.city
- (Optional) City name.
- assignedUsers.country
- Country name. To get the list of countries, use Get Countries API.
- assignedUsers.createdTime
- assignedUsers.designation
- (Optional) 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
- (Optional) 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
- (Optional) User phone number.
- assignedUsers.profileImage
- assignedUsers.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.
- assignedUsers.state
- (Optional) State name.
- assignedUsers.status
- assignedUsers.timeZone
- Time zone of the country. Use the Get Timezones API to get the list of timezones. Example: "timeZone": { "code": "EST"}
- assignedUsers.updatedTime
- assignedUsers.userAccountType
- (Optional) User account type: - REGULAR - BUSINESS
- assignedUsers.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
- assignedUsers.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.
- assignedUsers.userNotifications
- (Optional) Email to which the alert and report notifications are sent.
- assignedUsers.zip
- (Optional) Zip code.
authProtocolstring
autoEnableModeboolean
collectorTypestring
Collector type.
communitystring
credentialTypestring
Credential type.
descriptionstring
domainNamestring
Domain name.
enablePasswordstring
encryptPasswordstring
esxPasswordstring
esxUserNamestring
fileAuthScopestring
managementCertificatestring
managementCertificatePassphrasestring
namestring
Credential set name.
passwordstring
Credentials of user.
portinteger
secureboolean
securityLevelstring
Security level.
securityNamestring
snmpContextstring
snmpVersionstring
spAuthScopestring
spNameSpacestring
spPasswordstring
spPortinteger
spSecureboolean
spUserNamestring
sshCredentialTypestring
SSH credential type.
syncDataTSinteger
timeoutMsinteger
Time out, represented in milliseconds.
transportTypestring
Transport layer type.
uniqueIdstring
universalboolean
userNamestring
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
}