TransferUserGroupMemberships
# TransferUserGroupMemberships API
Transfers user group memberships from one user to another. The target user is added to all user groups where the source user is currently a member.
Endpoint¶
Methods¶
- GET
/srv.asmx/TransferUserGroupMemberships?authenticationTicket=...&fromUserName=...&toUserName=... - POST
/srv.asmx/TransferUserGroupMemberships(form data) - SOAP Action:
http://tempuri.org/TransferUserGroupMemberships
Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
authenticationTicket |
string | Yes | Authentication ticket obtained from AuthenticateUser. |
fromUserName |
string | Yes | The username whose group memberships will be transferred. |
toUserName |
string | Yes | The username who will receive the group memberships. |
Response¶
Success Response¶
Success Response (with warnings)¶
Error Response¶
Required Permissions¶
System administrator. Only system administrators can transfer user data between accounts.
Example¶
GET Request¶
GET /srv.asmx/TransferUserGroupMemberships
?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&fromUserName=jdoe
&toUserName=jsmith
HTTP/1.1
POST Request¶
POST /srv.asmx/TransferUserGroupMemberships HTTP/1.1
Content-Type: application/x-www-form-urlencoded
authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&fromUserName=jdoe
&toUserName=jsmith
SOAP Request¶
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tns="http://tempuri.org/">
<soap:Body>
<tns:TransferUserGroupMemberships>
<tns:AuthenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:AuthenticationTicket>
<tns:FromUserName>jdoe</tns:FromUserName>
<tns:ToUserName>jsmith</tns:ToUserName>
</tns:TransferUserGroupMemberships>
</soap:Body>
</soap:Envelope>
Notes¶
- The
toUserNameis added as a member of each user group wherefromUserNameis a member. - Groups where
toUserNameis already a member are skipped without error. - The response root element is
<root>, not<response>. - Typically used as part of a user offboarding process before deleting the source user.
Related APIs¶
- TransferUserDomainMemberships - Transfer domain memberships
- TransferUserDomainManagerRoles - Transfer domain manager roles
- DeleteUser - Delete a user after transferring their data
Error Codes¶
| Error | Description |
|---|---|
[900] Authentication failed |
Invalid or missing authentication ticket. |
[901] Session expired or Invalid ticket |
The ticket has expired or does not exist. |
| User not found | The specified fromUserName or toUserName does not exist. |
| Access denied | The calling user is not a system administrator. |
SystemError:... |
An unexpected server-side error occurred. |
For detailed documentation visit: https://support.inforouter.com/api-docs/TransferUserGroupMemberships