edit membership
| API Support | Available since | Last updated | Output |
|---|---|---|---|
Description
Edit a membership.
This service has been deprecated, use /groups/{group}/members/{member} [PATCH] instead.
Member details
Both the firstname and surname are limited to 20 characters.
The member-username must be less than 100 characters, unique and cannot contain a '@'.
The email must be less than 100 characters, unique and be a valid Email address.
Password details
The member-password must be less than 100 characters.
Passwords must satisfy a given strength check to be accepted:
- Regular members must have at least a MEDIUM strength.
- Administrators must use a STRONG password.
Group membership parameters
The notification parameter must be one of immediate, daily or none. Users are able to subsequently change this setting through the user interface in their group registration options.
The role parameter must be one of guest, reviewer, contributor, manager, approver, moderator-and-approver, moderator.
The listed boolean parameter can be used to override the group’s default setting. It affects whether other group member are able to see the member’s user details. Users are able to subsequently change this setting through the user interface in their group registration options.
Additional information specific to the group can also be attached to the user using the details fields field1 to field15.
This service can be used to deregister a member from a group by setting the deregister parameter to true.
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| current-password | The member’s current password (required by non-administrator if a new password is specified) | maybe | string | |
| accept | Set to true to accept an invitation to the group | no | boolean | false |
| deregister | Set to true to remove the user from the group | no | boolean | false |
| The member’s email | no | string | ||
| field1 | no | string | ||
| field10 | no | string | ||
| field11 | no | string | ||
| field12 | no | string | ||
| field13 | no | string | ||
| field14 | no | string | ||
| field15 | no | string | ||
| field2 | no | string | ||
| field3 | no | string | ||
| field4 | no | string | ||
| field5 | no | string | ||
| field6 | no | string | ||
| field7 | no | string | ||
| field8 | no | string | ||
| field9 | no | string | ||
| firstname | The member’s given name | no | string | |
| force-email-change | Set to true to change the email address without notification (admin only) | no | boolean | false |
| listed | Whether the member’s email address is listed in the group | no | boolean | |
| member-password | The member’s password | no | string | |
| member-username | The member’s username | no | string | |
| notification | The member¹s notification option in the group | no | string | |
| password-email | Set to false to change the password without notification (adminstrator only) | no | boolean | true |
| role | The member’s role in the group (admin only) | no | string | |
| surname | The member’s family name | no | string | |
| welcome-email | Whether to send a group welcome email to the member | no | boolean | true |
Permission
The current member or an administrator can invoke this service.
Response
<membership-modification [welcome-email-failed="true"]>
<membership id="[membershipid]"
email-listed="[true|false]"
notification="[none|immediate|daily]"
flags="[flags]"
[status="status"]
[role="status"]>
<member id="[member id]"
firstname="[first name]"
surname="[surname]"
username="[username]"
flags="[flags]"
status="[activated|unactivated]">
<fullname>[full name]</fullname>
</member>
<group|project id="[group id]"
name="[name]"
flags="[flags]"
visibility="[visibility]"
template="[template]">
<description>[description]</description>
</group|project>
</membership>
</membership-modification>