Groups & Users
Site groups and users can be requested via Web's .SiteGroups() and .SiteUsers() queriable collections correspondingly.
users, err := sp.Web().SiteUsers().Select("Email,Id").Filter("Email ne ''").OrderBy("Id", true).Get()if err != nil {log.Fatal(err)}for _, user := range users.Data() {fmt.Printf("%d: %s\n", user.Data().ID, user.Data().Email)}
groups, err := sp.Web().SiteGroups().Get()if err != nil {log.Fatal(err)}for _, group := range groups.Data() {fmt.Printf("%d: %s\n", user.Data().ID)}
You can't add new user via SharePoint API, but a user who exists in AD/AAD can be added to a site by ensuring him/her by a logon name.
user, err := sp.Web().EnsureUser("[email protected]")if err != nil {log.Fatal(err)}fmt.Printf("User: %+v\n", user)
We love the "power of defaults". Each web by default has three predefined groups: Owners, Members and Visitors. But their IDs and names are different from web to web. Luckily there is a helper for getting associated groups.
// .Members() and .Owners() correspondinglygroup, err := sp.Web().AssociatedGroups().Visitors().Get()if err != nil {log.Fatal(err)}fmt.Printf("Visitors group ID %d, Title \"%s\"\n",group.Data().ID,group.Data().Title,)
group, err := sp.Web().SiteGroups().Add("My group", nil)if err != nil {log.Fatal(err)}fmt.Printf("New group ID: %d\n", group.Data().ID)
// or .RemoveByID(groupID)if err := sp.Web().SiteGroups().RemoveByLoginName("My group"); err != nil {log.Fatal(err)}
user, err := sp.Web().EnsureUser("[email protected]")if err != nil {log.Fatal(err)}fmt.Printf("User login: %s\n", user.LoginName)// User login: i:0#.f|membership|[email protected]visitorGroup := sp.Web().AssociatedGroups().Visitors()if err := visitorGroup.AddUser(user.LoginName); err != nil {log.Fatal(err)}
In group's .AddUser method the argument should be full and valid login name including security provider membership prefix. For instance, while you can ensure Jane using [email protected] the same as an .AddUser method will fail as Jane's login is actually different i:0#.f|membership|[email protected].
If you already know UserID but not sure about LoginName .AddUserByID helper is at the disposal.
Similarly as with adding users:
user, err := sp.Web().EnsureUser("[email protected]")if err != nil {log.Fatal(err)}memberGroup := sp.Web().AssociatedGroups().Members()if err := memberGroup.RemoveUser(user.LoginName); err != nil {log.Fatal(err)}// orif err := memberGroup.RemoveUserByID(user.ID); err != nil {log.Fatal(err)}
memberGroup := sp.Web().AssociatedGroups().Members()if err := memberGroup.SetAsOwner(user.ID); err != nil {log.Fatal(err)}
users, err := sp.Web().AssociatedGroups().Visitors().Users().Select("Id,Title").Get()if err != nil {log.Fatal(err)}for _, user := range users.Data() {fmt.Printf("%d: %s\n", user.Data().ID, user.Data().Title)}
That's it, most of the common actions with groups and users are covered.
You'd probably will be interested with the connected topics:
