UpdateUserGroupName API¶

Updates the name of the specified infoRouter user group.

Endpoint¶

/srv.asmx/UpdateUserGroupName

Methods¶

GET /srv.asmx/UpdateUserGroupName?authenticationTicket=...&DomainName=...&GroupName=...&NewGroupName=...
POST /srv.asmx/UpdateUserGroupName (form data)
SOAP Action: http://tempuri.org/UpdateUserGroupName

Parameters¶

Parameter	Type	Required	Description
`authenticationTicket`	string	Yes	Authentication ticket obtained from `AuthenticateUser`.
`DomainName`	string	No	The domain/library name if the group is a local group. Pass empty or null for global groups.
`GroupName`	string	Yes	The current name of the user group to rename.
`NewGroupName`	string	Yes	The new name for the user group. Maximum 64 characters; a longer value is refused with `4000`.

Response¶

Success Response¶

<response success="true" error="" />

Error Response¶

<response success="false" error="Error message" errorCode="4000" />

Required Permissions¶

Domain manager or system administrator. The calling user must be a manager of the domain containing the group, or a system administrator for global groups.

Example¶

GET Request (rename local group)¶

GET /srv.asmx/UpdateUserGroupName
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &DomainName=Finance
  &GroupName=FinanceAdmins
  &NewGroupName=FinanceManagers
HTTP/1.1

POST Request¶

POST /srv.asmx/UpdateUserGroupName HTTP/1.1
Content-Type: application/x-www-form-urlencoded

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&DomainName=Finance
&GroupName=FinanceAdmins
&NewGroupName=FinanceManagers

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:UpdateUserGroupName>
      <tns:AuthenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:AuthenticationTicket>
      <tns:DomainName>Finance</tns:DomainName>
      <tns:GroupName>FinanceAdmins</tns:GroupName>
      <tns:NewGroupName>FinanceManagers</tns:NewGroupName>
    </tns:UpdateUserGroupName>
  </soap:Body>
</soap:Envelope>

JavaScript¶

Every call answers XML with HTTP 200, success or not, so success is the thing to branch on and errorCode is the number to report.

async function call(action, params) {
  const response = await fetch(`/srv.asmx/${action}?${new URLSearchParams(params)}`);
  const root = new DOMParser()
    .parseFromString(await response.text(), 'text/xml')
    .documentElement;

  if (root.getAttribute('success') !== 'true') {
    throw new Error(`${root.getAttribute('errorCode')}: ${root.getAttribute('error')}`);
  }
  return root;
}

Renames a group. The id and the members survive.

await call('UpdateUserGroupName', {
  authenticationTicket: ticket,
  DomainName: 'Finance',
  GroupName: 'Approvers',
  NewGroupName: 'Invoice approvers'
});

Notes¶

This method only renames the group. The member visibility (public/showMembers) setting is not changed.
To rename the group and also update the member visibility setting, use UpdateUserGroupName1.
Pass empty DomainName or null for global groups.

UpdateUserGroupName1 - Rename a group and update member visibility
GetUserGroup - Get current group properties

Error Codes¶

The errorCode values this operation returns, checked against a running server:

`errorCode`	When
`4010`	the ticket is expired or unknown, or there is no ticket at all
`4030`	the caller may not manage groups - including a caller with no ticket at all
`4041`	no group by that name in that library
`4090`	the new name is already another group's
`HTTP 400`	a required string parameter was empty; refused by model binding, so there is no error document