Edit Group

Edit online

Edit an Active Directory or Lightweight Directory Access Protocol group.

Request

Edit online

Security

Edit online
Table 1. Roles capable of executing the Edit Group (editGroup) API method
Any Super User System Admin Security Admin Operator
  superUser   securityAdmin  

HTTP method

Edit online

POST /manager/api/{apiResponseType}/editGroup.adm HTTP/1.1 HOST:{manager.dsnet} id={groupId}

Curl method

Edit online

curl -u {admin}:{password} -k “https://{manager.dsnet}/manager/api/{apiResponseType}/editGroup.adm” -d “id={groupId}”

Parameters

Edit online
Table 2. Request Parameters for Edit Group (editGroup) API method
Parameter Type Usage Default Description
id Long Required  

ID of the group to be modified.
alias String Optional  

Friendly name to give to the group.
rolesMap Set[{role}] Optional  

Key is name of role string that includes:

  • admin
  • systemAdmin
  • securityAdmin
  • operator
  • vaultProvisioner

An account cannot be assigned with readOnlysystemAdmin/SystemAdmin or readOnlySecurityOfficer/securityOfficer together at the same time.

vaultUserPermissions Map[{vaultId}] Optional disabled

With specific vault ID, set vault access permissions to 1 of three options.

  • disabled
  • owner
  • readOnly
  • readWrite
  • readOnlySystemAdmin
  • readOnlySecurityAdmin

Multiple vaultUserPermission[{vaultId}] parameters can be passed as part of the editGroup call.

vaultUserPermission[1]=disabled
&vaultUserPermission[2]=owner
defaultDevicePermission String Optional noAccess Default access permission that can be set on all devices except manager that will enable user to perform actions using nut interface.

Can be 1 of 4 options

  • noAccess
  • readOnlyAccess
  • readWriteAccess
  • rootAccess
managerDevicePermission String Optional noAccess Manager access permission that is specific to manager devices to enable user to perform actions using nut interface. Can be 1 of 4 options as listed above
siteDevicePermissions Map[{siteId}] Optional noAccess For specific site ID, device access permission can be set to 1 of 4 options, as listed above
regionDevicePermissions Map{regionId} Optional noAccess For specific region ID, device access permission can be set to 1 of 4 options, as listed above
CAUTION:
The Distinguished Name of a group cannot be modified.