Create user groups
This is an optional step, but highly recommended to have a clearer vision and scalable way for role assignments! Feel free to skip it if your organisation is small and simple. Typically, if you have one discord role per organisation role, you can skip this step.
What are user groups?
User groups are an abstraction for logical groupings of users. With them, instead of assigning each user a role one by one, you can create user groups that represent a set of users (for example, one or multiple Discord roles), assign the user group to an organisation role, and then link users to the user group. This way, all users in that user group will inherit the permissions defined in the assigned organisation role.
You will see that group members also have permissions! These are NOT the same permissions as those in the organisation. The permissions defined in the user group represent what actions a user can on the user group itself. For example, members with the READ permission can only view the user group details, while members with the MANAGE permission can add or remove users from the user group.
The permissions a user has in a group does not matter when it comes to the organisation permissions and roles. A member that is in a group, whether they have READ or MANAGE permissions in that group, is considered a member of the group.
In general, you should give all members READ permission, and only trusted users MANAGE permission.
How do I create a user group?
To create a user group, simply go to the User Groups section in the left navigation bar, click on Add New, fill in the required details, and click “Create”. That’s it!
In general, we recommend creating at least the following groups: Officers, Members, Recruits, and Guests.
As you can see, this matches the typical roles we defined in the Create organisation roles section. As previously mentionned, this should be enough for most organisations, but feel free to customize the roles and permissions based on your organisation’s needs. That’s it! You have your organisation roles created! Now, you just need to link users or user groups to the roles you created.
Adding users to user groups
You can identify users: by their FoxStock ID or via a Discord role. Go to the User Groups section in the left navigation bar, select the user group you want to add users to and follow the instructions below.
Using their Foxstock ID
To add users by their FoxStock ID, click on Add User, enter the FoxStock ID of the user you want to add, select the permissions you want to give it, and click “Send”. That’s it!
At the moment, the field where you put the ID is showing “Email”, but it is actually the FoxStock ID. This will be fixed in a future update.
Using a Discord role
Before you proceed, make sure that the Foxstock Discord Bot is inside your Discord server. If not, use the Invitation link to have it added. You do not need to add any special permissions to the bot; the default ones are sufficient.
We are aware that it can take some time for the bot to sync a Discord server. If you don’t see your Discord roles in the dropdown, please wait a few minutes and try again. If your server is still not showing up after a while, please contact us on our Discord server . Once the bot has been added, don’t forget to refresh the page.
To add users by their Discord role, click on Add Discord, select the Discord server and role you want to link to the user group, select the permissions you want to give it, and click “Link Role”. That’s it! All users that have that Discord role will automatically become members of the user group.
You need the MANAGE_GUILD permission in the Discord server to link a Discord role to a user group. You usually need an administrator role on the Discord server itself to have this permission.
Do you use another platform for your community? Please let us know on our Discord server so we can consider adding support for it in the future. Support for more platforms will be considered only if enough users request it and based on complexity, however adding integrations with other platforms is currently placed at the lowest priority.
Roles
Organisation roles are collections of permissions that can be assigned to users or groups of users. A user that receives a role automatically becomes a member of the organisation and inherits all the permissions defined in that role.
You can create multiple roles with different permission sets to cater to various responsibilities within your organisation. For example, you might have a “Logistics Officer” role with MANAGE permissions and a “Driver” role with SUBMIT_ITEMS permissions.
Members always inherit the widest set of permissions from all their assigned roles. For example, if a user has two roles, one with READ permission and another with WRITE permission, they will have both READ and WRITE permissions.
We will learn more about linking users and user groups to roles in the Assign roles to user groups section.