Users

Users Query

Returns a paginated list of User objects, with optional filtering and ordering. Users represent people who can access and interact with the pyck system.

Arguments

Name	Type	Description
after	Cursor	Returns the elements in the list that come after the specified cursor
first	Int	Returns the first n elements from the list
before	Cursor	Returns the elements in the list that come before the specified cursor
last	Int	Returns the last n elements from the list
orderBy	UserOrder	Ordering options for users returned from the connection
where	UserWhereInput	Filtering options for users returned from the connection

Return Type

UserConnection! - A connection to a list of User objects with pagination information.

Usage Example

query {
  # Search users by email domain
  users(
    where: {
      emailContains: "@company.com"
    },
    orderBy: { direction: ASC, field: CREATED_AT }
  ) {
    edges {
      node {
        id
        username
        email
        firstName
        lastName
        isAdmin
        tenantID
        company {
          id
          name
        }
        roles {
          id
          name
        }
        groups {
          id
          name
        }
      }
      cursor
    }
    totalCount
  }
}

query {
  # Get admin users
  users(
    where: {
      isAdmin: true
    },
    first: 20
  ) {
    edges {
      node {
        id
        username
        email
        firstName
        lastName
        createdAt
        roles {
          id
          name
          description
        }
      }
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
  }
}

query {
  # Find users by name and company
  users(
    where: {
      firstNameContains: "John",
      hasCompanyWith: [
        { nameContains: "Tech" }
      ]
    }
  ) {
    edges {
      node {
        id
        username
        email
        firstName
        lastName
        company {
          id
          name
          organizationID
        }
        roles {
          name
        }
      }
    }
  }
}

Common Filters

• usernameContains - Search by username substring

• username - Find by exact username

• emailContains - Search by email substring

• email - Find by exact email address

• firstNameContains / lastNameContains - Search by name

• isAdmin - Filter by admin status

• tenantID - Filter by tenant

• hasCompany - Filter users who have a company

• hasCompanyWith - Filter by company criteria

• hasRoles - Filter users who have roles

• hasRolesWith - Filter by role criteria

Notes

• Users are authenticated through an Identity Provider (IDP)

• Each user belongs to a tenant for multi-tenancy support

• Users can be associated with a company within their tenant

• Role-based access control through roles and groups

• Legacy roles field is deprecated in favor of role relations

• Admin users have elevated privileges across the system

• Integration with external authentication systems via idpID field