Group

Group Type

Represents a group of users in the system. Groups provide a way to organize users and assign roles collectively for access control and permissions management.

Fields

Field	Type	Description
id	ID!	Unique identifier of the group
createdAt	Time!	Creation timestamp
createdBy	UUID!	User identifier who created the group
updatedAt	Time	Last update timestamp
updatedBy	UUID	User identifier who last updated the group
deletedAt	Time	Deletion timestamp
deletedBy	UUID	User identifier who deleted the group
tenantID	UUID!	Tenant identifier
name	String!	Name of the group
description	String	Description of the group

Connection Fields

The users and roles fields return Connection objects that support pagination, filtering, and ordering.

users Connection

users(
  after: Cursor
  first: Int
  before: Cursor
  last: Int
  orderBy: UserOrder
  where: UserWhereInput
): UserConnection!

roles Connection

roles(
  after: Cursor
  first: Int
  before: Cursor
  last: Int
  orderBy: RoleOrder
  where: RoleWhereInput
): RoleConnection!

Argument	Type	Description
after	Cursor	Returns elements after this cursor
first	Int	Returns the first n elements
before	Cursor	Returns elements before this cursor
last	Int	Returns the last n elements
orderBy	*Order	Ordering options (UserOrder or RoleOrder)
where	*WhereInput	Filtering options (UserWhereInput or RoleWhereInput)

Interfaces

• Node

Usage Example

query {
  groups(first: 10) {
    edges {
      node {
        id
        name
        description
        users(first: 50) {
          edges {
            node {
              id
              username
              email
              firstName
              lastName
            }
          }
          pageInfo {
            hasNextPage
            endCursor
          }
          totalCount
        }
        roles(first: 20) {
          edges {
            node {
              id
              name
              description
            }
          }
          totalCount
        }
        createdAt
        updatedAt
      }
    }
  }
}

Query with Filtering on Users

query {
  groups(first: 10) {
    edges {
      node {
        id
        name
        users(
          first: 20
          orderBy: { direction: ASC, field: USERNAME }
          where: { isAdmin: false }
        ) {
          edges {
            node {
              id
              username
              email
            }
          }
          totalCount
        }
      }
    }
  }
}

Relations

• Group M:N User: A group can contain multiple users, and users can belong to multiple groups

• Group M:N Role: A group can have multiple roles, and roles can be assigned to multiple groups

Purpose

Groups provide a convenient way to manage permissions by organizing users and assigning roles collectively. Instead of assigning roles to individual users, administrators can assign roles to groups and then add users to those groups. This simplifies access control management in multi-user environments.