Groups API - manually syncing group membership?

Judith · June 11, 2020, 1:15pm

I seem to have boxed myself into a corner here…

I have a membership site (also in Rails) and I’m using the Discourse API in order to automatically create and populate restricted forum groups for all of my user groups. This works great; I’m even giving each group a wiki post to start with. (I’ve posted my code.)

Now I’ve come across the issue that sometimes I need to manually sync up the group membership, for example when merging groups on my site or when the coordinator accidentally deleted/added people via the forum. For this purpose, I want to delete ALL Discourse group members and then re-add the ones that should be in it.

First problem: the Discourse API doesn’t seem to come with a DELETE ALL for group members, so I have to specify the names of everyone that should be deleted.

Second problem: I cannot actually retrieve the Discourse group’s current membership, because for whatever reason it’s asking me for the group NAME rather than ID. I’ve only stored the group ID on my site, because that’s what Discourse uses for the related PUT/POST/DELETE requests.

Third problem: It should be obvious, but I don’t see a way to retrieve the group’s name by supplying its ID, unless I want to retrieve all 200+ groups and iterate through them until I find one whose ID matches. This seems a ridiculous amount of trouble and also contravenes Rails conventions.

What am I missing?

EDIT: @codinghorror was really helpful last time - any ideas now?

codinghorror · June 13, 2020, 3:50pm

I’m not sure but maybe @justin or @blake could check in on this during their upcoming work week?

justin · June 15, 2020, 2:08pm

You seem to be right on this – you cannot access group resources with the ID number, only the name.

github.com

discourse/discourse/blob/70e50a2255ebb30c78891a7f846e833ab85b0a8b/app/controllers/groups_controller.rb#L113


      
                type: type,
                order: order,
                asc: params[:asc],
                filter: filter
              )
            )
          end
          
          def show
            respond_to do |format|
              group = find_group(:id)
          
              format.html do
                @title = group.full_name.present? ? group.full_name.capitalize : group.name
                @description_meta = group.bio_cooked.present? ? PrettyText.excerpt(group.bio_cooked, 300) : @title
                render :show
              end
          
              format.json do
                groups = Group.visible_groups(current_user)
                groups = groups.where(automatic: false) if !guardian.is_staff?

The ID referenced here is not an ID, but the name, per

github.com

discourse/discourse/blob/70e50a2255ebb30c78891a7f846e833ab85b0a8b/app/controllers/groups_controller.rb#L569


      
                  custom_fields = DiscoursePluginRegistry.editable_group_custom_fields
                  default_params << { custom_fields: custom_fields } unless custom_fields.blank?
                end
          
                default_params
              end
          
            params.require(:group).permit(*permitted_params)
          end
          
          def find_group(param_name, ensure_can_see: true)
            name = params.require(param_name)
            group = Group.find_by("LOWER(name) = ?", name.downcase)
            guardian.ensure_can_see!(group) if ensure_can_see
            group
          end
          
          def users_from_params
            if params[:usernames].present?
              users = User.where(username_lower: params[:usernames].split(",").map(&:downcase))
              raise Discourse::InvalidParameters.new(:usernames) if users.blank?

It probably makes sense to refactor the /g/<group-name> route to match how we now handle topics and categories. Something like /g/<group-name>/<id> or /g/patrons/41 and allow /g/41 to function the same way.

Until we fix that up, though, it seems the only way to accomplish what you’re looking for is:

Storing the group name alongside the id
Hitting g/<group-name>/members.json with a GET request to get the members
Loop through those to delete each so you can re-sync.

tobiaseigen · June 15, 2020, 3:50pm

This is an awesome problem to be looking into. Thanks for raising it, @Judith! Groups are so powerful and have so much promise! I noticed this issue recently as well, when looking at maintaining group membership from wordpress. It would be pretty neat to be able to automagically add/remove people from groups for country and region of the world they say they are based in, languages they speak, themes they are interested in, etc, when they sign up and update their profiles in wordpress.

@justin’s suggestion of storing both group name and group ID is a good one and I’ll pass it on to the folks working on this integration now.

One feature I’d also love to see added to the UI is the ability for admins or group owners to bulk remove all members from a group, and re-add them. This would allow them to reset their group memberships manually from time to time based on exports from wordpress, even if they don’t have an automated systme in place to add/remove people from groups as they update their profiles in wordpress.

Falco · June 15, 2020, 4:02pm

I recommend using SSO between your main site and Discourse. That way you get group membership handling for free, and will have a sync_sso endpoint to update the membership in a straightforward way.

Judith · June 15, 2020, 4:36pm

At first I was only using SSO, but then I ran into the problem that it only updates group membership when people log in. In the case of people not being re-elected, or otherwise losing the right to access a group, or gaining the right to access a group (and should receive email notifications for messages in the restricted group subforum), I need to add/remove them via the API.

Falco · June 15, 2020, 4:51pm

The sync_sso exists to address this exact problem! You can trigger what is effectively a “virtual” sso login anytime a membership change to fully sync up a user.

gassim · September 18, 2022, 8:52am

Hey!

Is this feature now available? Any updates on this?

Thanks!

Judith · December 13, 2022, 1:14pm

Any updates? @tobiaseigen

Topic		Replies	Views
Adding existing (and inviting new) users to a group Support	7	1669	September 26, 2020
User removed automatically from Custom groups WordPress	4	769	June 8, 2021
Automatically Adding New Users (from WP integration) To A Group WordPress	8	1589	July 7, 2020
Add Groups and Categories (with security) with WP-Discourse or the API? WordPress	7	1181	May 17, 2022
Memberpress: how to add users to groups upon Sign up WordPress	40	9225	June 8, 2024

Groups API - manually syncing group membership?

Related topics