Function

$().SPServices

Web Service

Users and Groups

Supported Operations

Note: Links in the Operation column will show you more details for the operation, including examples, if available. Links in the MSDN Documentation column will take you to the SDK on MSDN for that operation.

Operation Options MSDN Documentation Introduced
AddGroup groupName, ownerIdentifier, ownerType, defaultUserLoginName, description UserGroup.AddGroup Method 0.2.10
AddGroupToRole roleName, groupName UserGroup.AddGroupToRole Method 0.2.10
AddRole [webURL], roleName, description, permissionMask UserGroup.AddRole Method 0.2.1
AddRoleDef roleName, description, permissionMask UserGroup.AddRoleDef Method 0.6.0
AddUserCollectionToGroup groupName, usersInfoXml UserGroup.AddUserCollectionToGroup Method 0.6.0
AddUserCollectionToRole roleName, usersInfoXml UserGroup.AddUserCollectionToRole Method 0.6.0
AddUserToGroup groupName, userName, userLoginName, userEmail, userNotes UserGroup.AddUserToGroup Method 0.5.7
AddUserToRole roleName, userName, userLoginName, userEmail, userNotes UserGroup.AddUserToRole Method 0.5.7
GetAllUserCollectionFromWeb [webURL] UserGroup.GetAllUserCollectionFromWeb Method 0.2.10
GetGroupCollection groupNamesXml UserGroup.GetGroupCollection Method 0.2.10
GetGroupCollectionFromRole roleName UserGroup.GetGroupCollectionFromRole Method 0.2.10
GetGroupCollectionFromSite [webURL] UserGroup.GetGroupCollectionFromSite Method 0.2.10
GetGroupCollectionFromUser userLoginName UserGroup.GetGroupCollectionFromUser Method 0.2.10
GetGroupCollectionFromWeb [webURL] UserGroup.GetGroupCollectionFromWeb Method 0.2.10
GetGroupInfo groupName UserGroup.GetGroupInfo Method 0.2.10
GetRoleCollection roleNamesXml UserGroup.GetRoleCollection Method 0.2.10
GetRoleCollectionFromGroup groupName UserGroup.GetRoleCollectionFromGroup Method 0.2.10
GetRoleCollectionFromUser userLoginName UserGroup.GetRoleCollectionFromUser Method 0.2.10
GetRoleCollectionFromWeb [webURL] UserGroup.GetRoleCollectionFromWeb Method 0.2.10
GetRoleInfo roleName UserGroup.GetRoleInfo Method 0.2.10
GetRolesAndPermissionsForCurrentUser [webURL] UserGroup.GetRolesAndPermissionsForCurrentUser Method 0.2.10
GetRolesAndPermissionsForSite [webURL] UserGroup.GetRolesAndPermissionsForSite Method 0.2.10
GetUserCollection userLoginNamesXml UserGroup.GetUserCollection Method 0.2.10
GetUserCollectionFromGroup groupName UserGroup.GetUserCollectionFromGroup Method 0.2.10
GetUserCollectionFromRole roleName UserGroup.GetUserCollectionFromRole Method 0.2.10
GetUserCollectionFromSite None UserGroup.GetUserCollectionFromSite Method 0.2.10
GetUserCollectionFromWeb [webURL] UserGroup.GetUserCollectionFromWeb Method 0.2.10
GetUserInfo userLoginName UserGroup.GetUserInfo Method 0.2.3
GetUserLoginFromEmail emailXml UserGroup.GetUserLoginFromEmail Method 0.2.10
RemoveGroup groupName UserGroup.RemoveGroup Method 0.2.10
RemoveGroupFromRole roleName, groupName UserGroup.RemoveGroupFromRole Method 0.6.0
RemoveRole roleName Webs.RemoveRole Method 0.5.8
RemoveUserCollectionFromGroup groupName, userLoginNamesXml UserGroup.RemoveUserCollectionFromGroup Method 0.6.0
RemoveUserCollectionFromRole roleName, userLoginNamesXml UserGroup.RemoveUserCollectionFromRole Method 0.6.0
RemoveUserCollectionFromSite userLoginNamesXml UserGroup.RemoveUserCollectionFromSite Method 0.6.0
RemoveUserFromGroup groupName, userLoginName UserGroup.RemoveUserFromGroup Method 0.5.7
RemoveUserFromRole roleName, userLoginName UserGroup.RemoveUserFromRole Method 0.6.0
RemoveUserFromSite userLoginName UserGroup.RemoveUserFromSite Method 0.6.0
RemoveUserFromWeb userLoginName UserGroup.RemoveUserFromWeb Method 0.6.0
UpdateGroupInfo oldGroupName, groupName, ownerIdentifier, ownerType, description UserGroup.UpdateGroupInfo Method 0.6.0
UpdateRoleDefInfo oldRoleName, roleName, description, permissionMask UserGroup.UpdateRoleDefInfo Method 0.6.0
UpdateRoleInfo oldRoleName, roleName, description, permissionMask UserGroup.UpdateRoleInfo Method 0.6.0
UpdateUserInfo userLoginName, userName, userEmail, userNotes UserGroup.UpdateUserInfo Method 0.6.0

Last edited Sep 6, 2012 at 4:10 PM by sympmarc, version 21

Comments

No comments yet.