Endpoint
/api/v2/tenants/{tenantId}/roles
Path Parameters
tenantIdstring
allCredentialsboolean
(Optional) - For partner specific role: To allow users in a role to view all credentials sets of all clients for a partner, provide allCredentials: true. - For client specific role: To allow users in a role to view all credential sets of all clients, provide allCredentials: true. Credential sets are client-specific. To allow users in a role to view only specific credential sets, provide only the credential set IDs of the client provided in clients.
allDevicesboolean
(Optional) - For partner specific role: To allow all users to view all client devices for a partner, provide allDevices: true. - For client specific role: To allow users to view all client devices, provide allDevices: true.
clientsarray
(Optional) Configure the visibility of clients for users in a role: - For partner-level users: To allow users of a role to view specific clients, provide the respective client IDs. Note: You can also create a role without visibility of any clients. - For client-level users: To assign a role to specific clients, provide the respective client IDs.
Child Parameters
- clients.activated
- clients.name
- clients.uniqueId
credentialSetsarray
(Optional) Configure visibility of credentials sets for users in a role: A partner or client specific role can be created to allow users in a role to view all credentials, specific credentials, or no credentials.
Child Parameters
- credentialSets.accountId
- credentialSets.accountKey
- credentialSets.accountName
- credentialSets.apiEndPoint
- credentialSets.assignedDeviceGroups
- credentialSets.assignedDevices
- credentialSets.assignedUsers
- credentialSets.authProtocol
- credentialSets.autoEnableMode
- credentialSets.collectorType
- Collector type.
- credentialSets.community
- credentialSets.credentialType
- Credential type.
- credentialSets.description
- credentialSets.domainName
- Domain name.
- credentialSets.enablePassword
- credentialSets.encryptPassword
- credentialSets.esxPassword
- credentialSets.esxUserName
- credentialSets.fileAuthScope
- credentialSets.managementCertificate
- credentialSets.managementCertificatePassphrase
- credentialSets.name
- Credential set name.
- credentialSets.password
- Credentials of user.
- credentialSets.port
- credentialSets.secure
- credentialSets.securityLevel
- Security level.
- credentialSets.securityName
- credentialSets.snmpContext
- credentialSets.snmpVersion
- credentialSets.spAuthScope
- credentialSets.spNameSpace
- credentialSets.spPassword
- credentialSets.spPort
- credentialSets.spSecure
- credentialSets.spUserName
- credentialSets.sshCredentialType
- SSH credential type.
- credentialSets.syncDataTS
- credentialSets.timeoutMs
- Time out, represented in milliseconds.
- credentialSets.transportType
- Transport layer type.
- credentialSets.uniqueId
- credentialSets.universal
- credentialSets.userName
- Credentials of user.
defaultRoleboolean
descriptionstring
(Optional) Short summary describing a role.
deviceGroupsarray
(Optional) For partner specific role: To allow all users to view all client devices for a partner, provide allDevices: true. For client specific role: To allow users to view all client devices, provide allDevices: true.
Child Parameters
- deviceGroups.assignDevices
- deviceGroups.client
- deviceGroups.createdTime
- deviceGroups.description
- deviceGroups.deviceCount
- deviceGroups.id
- deviceGroups.name
- deviceGroups.updatedTime
devicesarray
(Optional) Configure the visibility of devices for users in a role: A partner and client specific roles can be created with visibility to all devices, specific devices and without any devices.
Child Parameters
- devices.bios
- devices.clientUniqueId
- devices.generalInfo
- devices.id
- devices.ipAddress
- devices.state
- devices.status
- devices.type
- devices.uniqueId
idstring
namestring
Role name.
permissionsarray
(Optional) Assign permission sets to a role. All users in a role would be assigned these permissions. Search Permissions Sets API is used to get the list of permissions for a partner or client.
Child Parameters
- permissions.description
- permissions.id
- permissions.name
scopestring
(Optional) Define the applicability of a role. - Provide scope: MSP to create a partner-level role. Note: MSP indicates a Partner. - Provide scope: CLIENT to create a client-level role.
userGroupsarray
(Optional) Assign users to a role. Note: - Only partner users can be assigned to a partner specific role. - Only client users can be assigned a client specific role.
Child Parameters
- userGroups.description
- userGroups.name
- userGroups.uniqueId
usersarray
(Optional) Assign users to a role. Note: - Only partner users can be assigned to a partner specific role. - Only client users can be assigned a client specific role.
Child Parameters
- users.address
- (Optional) User address.
- users.altEmail
- users.authType
- users.changePassword
- users.city
- (Optional) City name.
- users.country
- Country name. To get the list of countries, use Get Countries API.
- users.createdTime
- users.designation
- (Optional) User designation.
- users.email
- Email of the user. (Alert and report notifications are sent to the email address.)
- users.firstName
- User first name.
- users.id
- users.lastName
- User last name
- users.loginName
- User login name.
- users.mobileNumber
- (Optional) User mobile number.
- users.orgId
- users.organizationName
- users.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
- users.phoneNumber
- (Optional) User phone number.
- users.profileImage
- users.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.
- users.state
- (Optional) State name.
- users.status
- users.timeZone
- Time zone of the country. Use the Get Timezones API to get the list of timezones. Example: "timeZone": { "code": "EST"}
- users.updatedTime
- users.userAccountType
- (Optional) User account type: - REGULAR - BUSINESS
- users.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
- users.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.
- users.userNotifications
- (Optional) Email to which the alert and report notifications are sent.
- users.zip
- (Optional) Zip code.
{
"allCredentials": true,
"allDevices": true,
"description": "Client Network Administrator",
"name": "Network Admin client",
"permissions": [
{
"id": 14
},
{
"id": 20
}
],
"userGroups": [
{
"uniqueId": "USRGRP-ab5afe06-0cca-9b8f-6053-357531f7d9ff"
},
{
"uniqueId": "USRGRP-13cfc012-bb01-bbe3-6ed9-c46a192d0567"
}
],
"users": [
{
"id": "USR0000000014"
},
{
"id": "USR0000000029"
}
]
}
{
"credentialSets": [
{
"uniqueId": "GxGJJk65Vr6mGUTx8uGBgMNx"
},
{
"uniqueId": "SgTGcRRs9BeTbBfyXYSSnHXB"
}
],
"description": "Client Network Administrator",
"deviceGroups": [
{
"id": "DGP-876f73a7-c0e4-409c-a757-5c64205ff97a"
},
{
"id": "DGP-7f2a0a45-21b2-45f9-a5d1-cb71ea990a9d"
}
],
"devices": [
{
"id": "ad0a218d-7512-435c-9b58-614470ee8658"
},
{
"id": "d628b4f1-37ad-49de-8487-43125ec3178a"
}
],
"name": "Network Admin client",
"permissions": [
{
"id": 20
},
{
"id": 6
}
],
"userGroups": [
{
"uniqueId": "USRGRP-ab5afe06-0cca-9b8f-6053-357531f7d9ff"
},
{
"uniqueId": "USRGRP-13cfc012-bb01-bbe3-6ed9-c46a192d0567"
}
],
"users": [
{
"id": "USR0000000014"
},
{
"id": "USR0000000029"
}
]
}
{
"allClients": true,
"allCredentials": true,
"allDevices": true,
"description": "Client Network Administrator",
"name": "Network Admin",
"permissions": [
{
"id": 11
},
{
"id": 13
}
],
"scope": "MSP",
"userGroups": [
{
"uniqueId": "USRGRP-5dd6cb59-b4cf-083a-29f6-7f6fc2688fd3"
},
{
"uniqueId": "USRGRP-98c1733f-0429-001d-8196-54a85e15d49d"
}
],
"users": [
{
"id": "USR0000000011"
},
{
"id": "USR0000000013"
}
]
}
{
"clients": [
{
"uniqueId": "client_8"
},
{
"uniqueId": "client_9"
}
],
"credentialSets": [
{
"uniqueId": "GxGJJk65Vr6mGUTx8uGBgMNx"
},
{
"uniqueId": "y9rxRm4sMP6u5sWRKMqUu6cz"
}
],
"description": "Client Network Administrator",
"deviceGroups": [
{
"id": "DGP-fbbabccc-578b-4658-9475-178ab034c20b"
},
{
"id": "DGP-3cac84fa-1613-4035-ac23-e44c0a450a9c"
}
],
"devices": [
{
"id": "49429c1c-aba5-4c1a-92c5-dd66211a5b73"
},
{
"id": "ec9ac14c-c566-41da-8b61-1452357b6506"
}
],
"name": "Network Admin",
"permissions": [
{
"id": 11
},
{
"id": 13
}
],
"scope": "MSP",
"userGroups": [
{
"uniqueId": "USRGRP-5dd6cb59-b4cf-083a-29f6-7f6fc2688fd3"
},
{
"uniqueId": "USRGRP-98c1733f-0429-001d-8196-54a85e15d49d"
}
],
"users": [
{
"id": "USR0000000011"
},
{
"id": "USR0000000013"
}
]
}
Responses
OK
allCredentialsboolean
(Optional) - For partner specific role: To allow users in a role to view all credentials sets of all clients for a partner, provide allCredentials: true. - For client specific role: To allow users in a role to view all credential sets of all clients, provide allCredentials: true. Credential sets are client-specific. To allow users in a role to view only specific credential sets, provide only the credential set IDs of the client provided in clients.
allDevicesboolean
(Optional) - For partner specific role: To allow all users to view all client devices for a partner, provide allDevices: true. - For client specific role: To allow users to view all client devices, provide allDevices: true.
clientsarray
(Optional) Configure the visibility of clients for users in a role: - For partner-level users: To allow users of a role to view specific clients, provide the respective client IDs. Note: You can also create a role without visibility of any clients. - For client-level users: To assign a role to specific clients, provide the respective client IDs.
Child Parameters
- clients.activated
- clients.name
- clients.uniqueId
credentialSetsarray
(Optional) Configure visibility of credentials sets for users in a role: A partner or client specific role can be created to allow users in a role to view all credentials, specific credentials, or no credentials.
Child Parameters
- credentialSets.accountId
- credentialSets.accountKey
- credentialSets.accountName
- credentialSets.apiEndPoint
- credentialSets.assignedDeviceGroups
- credentialSets.assignedDevices
- credentialSets.assignedUsers
- credentialSets.authProtocol
- credentialSets.autoEnableMode
- credentialSets.collectorType
- Collector type.
- credentialSets.community
- credentialSets.credentialType
- Credential type.
- credentialSets.description
- credentialSets.domainName
- Domain name.
- credentialSets.enablePassword
- credentialSets.encryptPassword
- credentialSets.esxPassword
- credentialSets.esxUserName
- credentialSets.fileAuthScope
- credentialSets.managementCertificate
- credentialSets.managementCertificatePassphrase
- credentialSets.name
- Credential set name.
- credentialSets.password
- Credentials of user.
- credentialSets.port
- credentialSets.secure
- credentialSets.securityLevel
- Security level.
- credentialSets.securityName
- credentialSets.snmpContext
- credentialSets.snmpVersion
- credentialSets.spAuthScope
- credentialSets.spNameSpace
- credentialSets.spPassword
- credentialSets.spPort
- credentialSets.spSecure
- credentialSets.spUserName
- credentialSets.sshCredentialType
- SSH credential type.
- credentialSets.syncDataTS
- credentialSets.timeoutMs
- Time out, represented in milliseconds.
- credentialSets.transportType
- Transport layer type.
- credentialSets.uniqueId
- credentialSets.universal
- credentialSets.userName
- Credentials of user.
defaultRoleboolean
descriptionstring
(Optional) Short summary describing a role.
deviceGroupsarray
(Optional) For partner specific role: To allow all users to view all client devices for a partner, provide allDevices: true. For client specific role: To allow users to view all client devices, provide allDevices: true.
Child Parameters
- deviceGroups.assignDevices
- deviceGroups.client
- deviceGroups.createdTime
- deviceGroups.description
- deviceGroups.deviceCount
- deviceGroups.id
- deviceGroups.name
- deviceGroups.updatedTime
devicesarray
(Optional) Configure the visibility of devices for users in a role: A partner and client specific roles can be created with visibility to all devices, specific devices and without any devices.
Child Parameters
- devices.bios
- devices.clientUniqueId
- devices.generalInfo
- devices.id
- devices.ipAddress
- devices.state
- devices.status
- devices.type
- devices.uniqueId
idstring
namestring
Role name.
permissionsarray
(Optional) Assign permission sets to a role. All users in a role would be assigned these permissions. Search Permissions Sets API is used to get the list of permissions for a partner or client.
Child Parameters
- permissions.description
- permissions.id
- permissions.name
scopestring
(Optional) Define the applicability of a role. - Provide scope: MSP to create a partner-level role. Note: MSP indicates a Partner. - Provide scope: CLIENT to create a client-level role.
userGroupsarray
(Optional) Assign users to a role. Note: - Only partner users can be assigned to a partner specific role. - Only client users can be assigned a client specific role.
Child Parameters
- userGroups.description
- userGroups.name
- userGroups.uniqueId
usersarray
(Optional) Assign users to a role. Note: - Only partner users can be assigned to a partner specific role. - Only client users can be assigned a client specific role.
Child Parameters
- users.address
- (Optional) User address.
- users.altEmail
- users.authType
- users.changePassword
- users.city
- (Optional) City name.
- users.country
- Country name. To get the list of countries, use Get Countries API.
- users.createdTime
- users.designation
- (Optional) User designation.
- users.email
- Email of the user. (Alert and report notifications are sent to the email address.)
- users.firstName
- User first name.
- users.id
- users.lastName
- User last name
- users.loginName
- User login name.
- users.mobileNumber
- (Optional) User mobile number.
- users.orgId
- users.organizationName
- users.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
- users.phoneNumber
- (Optional) User phone number.
- users.profileImage
- users.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.
- users.state
- (Optional) State name.
- users.status
- users.timeZone
- Time zone of the country. Use the Get Timezones API to get the list of timezones. Example: "timeZone": { "code": "EST"}
- users.updatedTime
- users.userAccountType
- (Optional) User account type: - REGULAR - BUSINESS
- users.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
- users.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.
- users.userNotifications
- (Optional) Email to which the alert and report notifications are sent.
- users.zip
- (Optional) Zip code.
{
"allCredentials": true,
"allDevices": true,
"clients": [
{
"activated": true,
"id": 8,
"name": "NECE Lab",
"uniqueId": "client_8"
}
],
"defaultRole": false,
"description": "Client Network Administrator",
"name": "Network Admin client",
"permissions": [
{
"description": "IM Link Client Administrator",
"id": 14,
"name": "IM Link Client Administrator"
},
{
"description": "Full Client Permissions",
"id": 20,
"name": "Full Client Permissions"
}
],
"uniqueId": "ROLE-0074b24b-5c0b-2332-dd99-fea506f6cebd",
"userGroups": [
{
"description": "All NECE Lab Users group",
"name": "NECE Lab Users",
"uniqueId": "USRGRP-ab5afe06-0cca-9b8f-6053-357531f7d9ff"
},
{
"description": "All NECE lab escalation users",
"name": "NECE Lab Escalation Users",
"uniqueId": "USRGRP-13cfc012-bb01-bbe3-6ed9-c46a192d0567"
}
],
"users": [
{
"email": "john.smith@gamil.com",
"firstName": "NECE",
"id": "USR0000000014",
"lastName": "Lab",
"loginName": "NECELab@opsramp.com",
"phoneNumber": "8096250653"
},
{
"email": "test@opsramp.com",
"firstName": "Client",
"id": "USR0000000029",
"lastName": "Admin",
"loginName": "Admin",
"phoneNumber": ""
}
]
}
{
"clients": [
{
"activated": true,
"name": "NECE Lab",
"uniqueId": "client_8"
}
],
"credentialSets": [
{
"autoEnableMode": false,
"description": "SSH Credentials",
"name": "SSH",
"port": 222,
"secure": false,
"snmpVersion": "V2",
"spPort": 0,
"spSecure": false,
"timeoutMs": 10000,
"uniqueId": "GxGJJk65Vr6mGUTx8uGBgMNx",
"universal": true
},
{
"autoEnableMode": false,
"description": "SSH Credentails",
"id": 62,
"name": "SSH Credential",
"port": 22,
"secure": false,
"snmpVersion": "V2",
"spPort": 0,
"spSecure": false,
"timeoutMs": 10000,
"uniqueId": "SgTGcRRs9BeTbBfyXYSSnHXB",
"universal": true
}
],
"defaultRole": false,
"description": "Client Network Administrator",
"deviceGroups": [
{
"createdDate": "2016-07-24T07:27:44+0000",
"description": "Windows Systems at HYD",
"id": "DGP-876f73a7-c0e4-409c-a757-5c64205ff97a",
"name": "HYD-WINDOWS",
"updatedDate": "2016-07-24T07:33:15+0000"
},
{
"createdDate": "2016-12-06T11:18:58+0000",
"id": "DGP-7f2a0a45-21b2-45f9-a5d1-cb71ea990a9d",
"name": "Policy Groups",
"updatedDate": "2016-12-06T11:18:58+0000"
}
],
"devices": [
{
"clientUniqueId": "client_8",
"generalInfo": {
"hostName": "WORK-PC",
"ipAddresses": "192.168.126.1"
},
"id": "ad0a218d-7512-435c-9b58-614470ee8658",
"type": "DEVICE"
},
{
"clientUniqueId": "client_8",
"generalInfo": {
"hostName": "HYDLPT204",
"ipAddresses": "172.28.16.15"
},
"id": "d628b4f1-37ad-49de-8487-43125ec3178a",
"type": "DEVICE"
}
],
"name": "Network Admin client",
"permissions": [
{
"description": "End customer role",
"id": 6,
"name": "Customer"
},
{
"description": "Full Client Permissions",
"id": 20,
"name": "Full Client Permissions"
}
],
"uniqueId": "ROLE-0074b24b-5c0b-2332-dd99-fea506f6cebd",
"userGroups": [
{
"description": "All NECE Lab Users group",
"name": "NECE Lab Users",
"uniqueId": "USRGRP-ab5afe06-0cca-9b8f-6053-357531f7d9ff"
},
{
"description": "All NECE lab escalation users",
"name": "NECE Lab Escalation Users",
"uniqueId": "USRGRP-13cfc012-bb01-bbe3-6ed9-c46a192d0567"
}
],
"users": [
{
"email": "john.smith@gamil.com",
"firstName": "NECE",
"id": "USR0000000014",
"lastName": "Lab",
"loginName": "NECELab@opsramp.com",
"phoneNumber": "8096250653"
},
{
"email": "test@opsramp.com",
"firstName": "Client",
"id": "USR0000000029",
"lastName": "Admin",
"loginName": "Admin",
"phoneNumber": ""
}
]
}
{
"allClients": true,
"allCredentials": true,
"allDevices": true,
"defaultRole": false,
"description": "Client Network Administrator",
"name": "Network Admin",
"permissions": [
{
"description": "Partner Administrator",
"id": 11,
"name": "Partner Administrator"
},
{
"description": "Dispatcher",
"id": 13,
"name": "Dispatcher"
}
],
"uniqueId": "ROLE-0074b24b-5c0b-2332-dd99-fea506f6cebd",
"userGroups": [
{
"description": "NECE Partner Users",
"name": "NECE Inc Users",
"uniqueId": "USRGRP-5dd6cb59-b4cf-083a-29f6-7f6fc2688fd3"
},
{
"description": "NECE Inc Escalation Users",
"name": "NECE Inc Escalation Users",
"uniqueId": "USRGRP-98c1733f-0429-001d-8196-54a85e15d49d"
}
],
"users": [
{
"email": "john.smith@gamil.com",
"firstName": "NECE",
"id": "USR0000000011",
"lastName": "Inc Admin",
"loginName": "NECEInc@opsramp.com",
"phoneNumber": "8096250653"
},
{
"email": "john.smith@gamil.com",
"firstName": "NECE",
"id": "USR0000000013",
"lastName": "Inc PAdmin",
"loginName": "NECEPAdmin@opsramp.com",
"phoneNumber": "8096250653"
}
]
}
{
"clients": [
{
"activated": true,
"name": "NECE Lab",
"uniqueId": "client_8"
},
{
"activated": true,
"name": "NECE Corp.",
"uniqueId": "client_9"
}
],
"credentialSets": [
{
"autoEnableMode": false,
"description": "SSH Credentials",
"name": "SSH",
"port": 222,
"secure": false,
"snmpVersion": "V2",
"spPort": 0,
"spSecure": false,
"timeoutMs": 10000,
"uniqueId": "GxGJJk65Vr6mGUTx8uGBgMNx",
"universal": true
},
{
"autoEnableMode": false,
"description": "SSH Credential for Device Loggings",
"name": "SSH Credential for Device Loggings",
"port": 22,
"secure": false,
"snmpVersion": "V2",
"spPort": 0,
"spSecure": false,
"timeoutMs": 10000,
"uniqueId": "y9rxRm4sMP6u5sWRKMqUu6cz",
"universal": true
}
],
"defaultRole": false,
"description": "Client Network Administrator",
"deviceGroups": [
{
"createdDate": "2016-10-20T07:43:48+0000",
"description": "testing device group",
"id": "DGP-fbbabccc-578b-4658-9475-178ab034c20b",
"name": "Testing-dev-group",
"updatedDate": "2016-10-20T07:43:49+0000"
},
{
"createdDate": "2016-12-03T17:43:05+0000",
"description": "These are the main devices those always needs to be in up state.",
"id": "DGP-3cac84fa-1613-4035-ac23-e44c0a450a9c",
"name": "Up Agent Devices",
"updatedDate": "2016-12-05T16:00:46+0000"
}
],
"devices": [
{
"clientUniqueId": "client_8",
"generalInfo": {
"hostName": "HYDLPT044",
"ipAddresses": "172.24.102.169"
},
"id": "43d49023-4c47-4dbf-a59b-9c40610e1ab8",
"type": "DEVICE"
},
{
"clientUniqueId": "client_9",
"generalInfo": {
"hostName": "172.30.143.112",
"ipAddresses": "172.30.143.112"
},
"id": "ec9ac14c-c566-41da-8b61-1452357b6506",
"type": "DEVICE"
}
],
"name": "Network Admin",
"permissions": [
{
"description": "Partner Administrator",
"id": 11,
"name": "Partner Administrator"
},
{
"description": "Dispatcher",
"id": 13,
"name": "Dispatcher"
}
],
"uniqueId": "ROLE-0074b24b-5c0b-2332-dd99-fea506f6cebd",
"userGroups": [
{
"description": "NECE Partner Users",
"name": "NECE Inc Users",
"uniqueId": "USRGRP-5dd6cb59-b4cf-083a-29f6-7f6fc2688fd3"
},
{
"description": "NECE Inc Escalation Users",
"name": "NECE Inc Escalation Users",
"uniqueId": "USRGRP-98c1733f-0429-001d-8196-54a85e15d49d"
}
],
"users": [
{
"email": "john.smith@gamil.com",
"firstName": "NECE",
"id": "USR0000000011",
"lastName": "Inc Admin",
"loginName": "NECEInc@opsramp.com",
"phoneNumber": "8096250653"
},
{
"email": "john.smith@gamil.com",
"firstName": "NECE",
"id": "USR0000000013",
"lastName": "Inc PAdmin",
"loginName": "NECEPAdmin@opsramp.com",
"phoneNumber": "8096250653"
}
]
}