Group operations
Assigns a user to a group
Parameters
Parameter | Description |
Group id | Id of group |
Login name | Login name of user, not id |
Output
Record with information about whether operation failed or not.
Member | Description |
HasFailed | Whether operation has failed or not |
ErrorMessage | A description of the failure, if any |
ErrorCode | An error code related to operation failure. Is 0 if no failure occured |
Errors
Error code | Description |
1000 | Unspecified error. |
Detach user from group
Detaches the user from the group
Parameters
Parameter | Description |
Group id | Id of group |
Login name | Login name of user, not id |
Output
Record with information about whether operation failed or not.
Member | Description |
HasFailed | Whether operation has failed or not |
ErrorMessage | A description of the failure, if any |
ErrorCode | An error code related to operation failure. Is 0 if no failure occured |
Errors
Error code | Description |
1000 | Unspecified error. |
List site groups
Gets and list all site groups
Parameters
Parameter | Description |
Output
Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member
Member | Description |
HasFailed | Whether operation has failed or not |
ErrorMessage | A description of the failure, if any |
ErrorCode | An error code related to operation failure. Is 0 if no failure occured |
Results | Table variable containing the results of operation |
Structure of Results Results AllowMembersEditMembership AllowRequestToJoinLeave AutoAcceptRequestToJoinLeave CanCurrentUserEditMembership CanCurrentUserManageGroup CanCurrentUserViewMembership OnlyAllowMembersViewMembership RequestToJoinLeaveEmailSetting Id LoginName Title Description OwnerTitle
Errors
Error code | Description |
1000 | Unspecified error. |
List users by group id
List all users assigned to a group.
Parameters
Parameter | Description |
Group id | Id of group |
Output
Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member
Member | Description |
HasFailed | Whether operation has failed or not |
ErrorMessage | A description of the failure, if any |
ErrorCode | An error code related to operation failure. Is 0 if no failure occured |
Results | Table variable containing the results of operation |
Structure of Results Results
Id LoginName Email Title IsSiteAdmin
Errors
Error code | Description |
1000 | Unspecified error. |
Last updated