User Groups - Venddor IO

Within the realm of e-commerce, managing user permissions, roles, and categorizations is essential. Venddor IO's robust system provides you with an in-depth utility for managing user groups, ensuring a personalized experience for every user.

Endpoints for User Groups

Listing All User Groups

GET /api/usergroups/

Accessing Specific User Group

GET /api/usergroups/:id

Accessing Groups Associated with a User

GET /api/users/:id/usergroups/

Accessing a Specific Group for a User

GET /api/users/:id/usergroups/:id

Do note that user group IDs 1 and 2 are specially designated for Guests and Registered users, and they cannot be modified or removed.

Filtering User Groups

You can narrow down the user groups list using parameters:

type: Filter groups as either 'A' for administrators or 'C' for customers.
status: Defines visibility and usability with 'A' for active, 'D' for disabled, and 'H' for hidden.

Defining User Group Properties

Each user group is characterized by a set of fields:

usergroup_id: A unique identifier.
type: Differentiates between an admin ('A') or a customer ('C').
status: Determines the user group's active status.
usergroup: Specifies the user group's name.
privileges: Lists out the permissions assigned, particularly relevant for admin groups.

Working with User Groups

Creating a New User Group

POST /api/usergroups/

Modifying an Existing Group

PUT /api/usergroups/:id/

Deleting a User Group

DELETE /api/usergroups/:id

Interactions between Users and Their Groups

Viewing User's Groups

Obtain a detailed view of user's group affiliations, including their statuses within those groups.

Modifying User's Group Affiliation

Adjusting the status within a group can be done to add a user to a group or update their privileges.

Removing User from a Group

Easily remove a user from a specific group either by adjusting their status or employing the DELETE method.