probo/pkg/cmd/user/list/list.go

// Copyright (c) 2026 Probo Inc <hello@probo.com>.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

package list

import (
	"encoding/json"
	"fmt"

	"github.com/spf13/cobra"
	"go.probo.inc/probo/pkg/cli/api"
	"go.probo.inc/probo/pkg/cmd/cmdutil"
)

const listQuery = `
query($id: ID!, $first: Int, $after: CursorKey, $orderBy: ProfileOrder, $filter: ProfileFilter) {
  node(id: $id) {
    __typename
    ... on Organization {
      profiles(first: $first, after: $after, orderBy: $orderBy, filter: $filter) {
        totalCount
        edges {
          node {
            id
            fullName
            emailAddress
            state
            kind
            position
          }
        }
        pageInfo {
          hasNextPage
          endCursor
        }
      }
    }
  }
}
`

type profile struct {
	ID           string  `json:"id"`
	FullName     string  `json:"fullName"`
	EmailAddress string  `json:"emailAddress"`
	State        string  `json:"state"`
	Kind         *string `json:"kind"`
	Position     *string `json:"position"`
}

func NewCmdList(f *cmdutil.Factory) *cobra.Command {
	var (
		flagOrg           string
		flagLimit         int
		flagOrder         string
		flagOrderDir      string
		flagContractEnded string
		flagState         []string
		flagFilter        string
		flagRole          string
		flagKind          string
		flagOutput        *string
	)

	cmd := &cobra.Command{
		Use:     "list",
		Short:   "List users in an organization",
		Aliases: []string{"ls"},
		Example: `  # List users in the default organization
  prb user list

  # List only active users
  prb user ls --state ACTIVE

  # Search users by name or email
  prb user ls --filter alice

  # List only admins
  prb user ls --role ADMIN

  # Filter by type
  prb user ls --kind EMPLOYEE

  # List users whose contract has ended
  prb user ls --contract-ended true`,
		Args: cobra.NoArgs,
		RunE: func(cmd *cobra.Command, args []string) error {
			if err := cmdutil.ValidateOutputFlag(flagOutput); err != nil {
				return err
			}

			cfg, err := f.Config()
			if err != nil {
				return err
			}

			host, hc, err := cfg.DefaultHost()
			if err != nil {
				return err
			}

			client := api.NewClient(
				host,
				hc.Token,
				"/api/console/v1/graphql",
				cfg.HTTPTimeoutDuration(),
				cmdutil.TokenRefreshOption(cfg, host, hc),
			)

			if flagOrg == "" {
				flagOrg = hc.Organization
			}

			if flagOrg == "" {
				return fmt.Errorf("organization is required; pass --org or set a default with 'prb auth login'")
			}

			variables := map[string]any{
				"id": flagOrg,
			}

			if flagOrder != "" {
				if err := cmdutil.ValidateEnum("order-by", flagOrder, []string{"FULL_NAME", "CREATED_AT", "KIND"}); err != nil {
					return err
				}

				variables["orderBy"] = map[string]any{
					"field":     flagOrder,
					"direction": flagOrderDir,
				}
			}

			filter := map[string]any{}

			if flagContractEnded != "" {
				if err := cmdutil.ValidateEnum("contract-ended", flagContractEnded, []string{"true", "false"}); err != nil {
					return err
				}

				filter["contractEnded"] = flagContractEnded == "true"
			}

			if len(flagState) > 0 {
				for _, state := range flagState {
					if err := cmdutil.ValidateEnum("state", state, []string{"PENDING", "ACTIVE", "DEACTIVATED"}); err != nil {
						return err
					}
				}

				filter["states"] = flagState
			}

			if flagFilter != "" {
				filter["query"] = flagFilter
			}

			if flagRole != "" {
				if err := cmdutil.ValidateEnum("role", flagRole, []string{"OWNER", "ADMIN", "VIEWER", "AUDITOR", "EMPLOYEE"}); err != nil {
					return err
				}

				filter["role"] = flagRole
			}

			if flagKind != "" {
				if err := cmdutil.ValidateEnum("kind", flagKind, []string{"EMPLOYEE", "CONTRACTOR", "SERVICE_ACCOUNT"}); err != nil {
					return err
				}

				filter["kind"] = flagKind
			}

			if len(filter) > 0 {
				variables["filter"] = filter
			}

			profiles, totalCount, err := api.Paginate(
				client,
				listQuery,
				variables,
				flagLimit,
				func(data json.RawMessage) (*api.Connection[profile], error) {
					var resp struct {
						Node *struct {
							Typename string                  `json:"__typename"`
							Profiles api.Connection[profile] `json:"profiles"`
						} `json:"node"`
					}
					if err := json.Unmarshal(data, &resp); err != nil {
						return nil, err
					}

					if resp.Node == nil {
						return nil, fmt.Errorf("organization %s not found", flagOrg)
					}

					if resp.Node.Typename != "Organization" {
						return nil, fmt.Errorf("expected Organization node, got %s", resp.Node.Typename)
					}

					return &resp.Node.Profiles, nil
				},
			)
			if err != nil {
				return err
			}

			if *flagOutput == cmdutil.OutputJSON {
				return cmdutil.PrintJSON(f.IOStreams.Out, profiles)
			}

			if len(profiles) == 0 {
				_, _ = fmt.Fprintln(f.IOStreams.Out, "No users found.")
				return nil
			}

			rows := make([][]string, 0, len(profiles))
			for _, p := range profiles {
				kind := ""
				if p.Kind != nil {
					kind = *p.Kind
				}

				position := ""
				if p.Position != nil {
					position = *p.Position
				}

				rows = append(rows, []string{
					p.ID,
					p.FullName,
					p.EmailAddress,
					p.State,
					kind,
					position,
				})
			}

			t := cmdutil.NewTable("ID", "NAME", "EMAIL", "STATE", "KIND", "POSITION").Rows(rows...)

			_, _ = fmt.Fprintln(f.IOStreams.Out, t)

			if totalCount > len(profiles) {
				_, _ = fmt.Fprintf(
					f.IOStreams.ErrOut,
					"\nShowing %d of %d users\n",
					len(profiles),
					totalCount,
				)
			}

			return nil
		},
	}

	cmd.Flags().StringVar(&flagOrg, "org", "", "Organization ID")
	cmd.Flags().IntVarP(&flagLimit, "limit", "L", 30, "Maximum number of users to list")
	cmd.Flags().StringVar(&flagOrder, "order-by", "", "Order by field (FULL_NAME, CREATED_AT, KIND)")
	cmd.Flags().StringVar(&flagOrderDir, "order-direction", "DESC", "Sort direction (ASC, DESC)")
	cmd.Flags().StringVar(&flagContractEnded, "contract-ended", "", "Filter by contract status (true or false)")
	cmd.Flags().StringSliceVar(&flagState, "state", nil, "Filter by profile state; repeat or comma-separate for multiple (PENDING, ACTIVE, DEACTIVATED)")
	cmd.Flags().StringVarP(&flagFilter, "filter", "q", "", "Filter users by name or email search query")
	cmd.Flags().StringVar(&flagRole, "role", "", "Filter by membership role (OWNER, ADMIN, VIEWER, AUDITOR, EMPLOYEE)")
	cmd.Flags().StringVar(&flagKind, "kind", "", "Filter by profile kind (EMPLOYEE, CONTRACTOR, SERVICE_ACCOUNT)")
	flagOutput = cmdutil.AddOutputFlag(cmd)

	return cmd
}