mm-user-groups

Matter In Motion. User groups extension

This extension adds groups support for the user resource.

Usage

Extensions installation instructions

Settings

This extension adds settings to the user settings.

• sudo — string, default 'sudo'. Name of the superuser group that allowed to manage other users groups.

API

All methods require a user to be authorized

user.addGroup

Adds the user to the group.

Request

• group — string, group to add
• user — uuid, an id of the user to add the group. If not provided authorized user id is used.

Response

• true — when the group is added.
• Unauthorized error, code 4100 — when the user does not have permission to change groups.
• NotFound error, code 4540 — when user not found.
• AlreadyAMemberError error, code 4521 — when the user is already a member of the group

user.deleteGroup

Deletes the user from the group.

Request

• group — string, group to add
• user — uuid, an id of the user to delete the group from. If not provided authorized user id is used.

Response

• true — when the group was added
• Unauthorized error, code 4100 — when the user does not have permission to change groups
• NotFound error, code 4540 — when user not found
• NotAMemberError error, code 4522 — when the user is not a member of the group

user.hasGroup

Check if the user in the group

Request

• group — string, group to add
• user — uuid, an id of the user to check. If not provided authorized user id is used.

Response

• true — when the user is a member of the group.
• NotAMemberError error, code 4522 — when the user is not a member of the group.
• NotFound error, code 4540 — when user not found.

Commands

user addGroup

Adds the user to the group

user deleteGroup

Deletes the user from the group

License: MIT