Skip to content

Add platform users list command - #17

Merged
dishantlangayan merged 2 commits into
mainfrom
add-platform-users-list-command
Oct 26, 2026
Merged

dishantlangayan merged 2 commits into
mainfrom
add-platform-users-list-command

Conversation

@dishantlangayan

Copy link
Copy Markdown
Collaborator

No description provided.

dishantlangayan and others added 2 commits October 25, 2026 22:27
Documents the conventions established by the platform env commands so new
commands are consistent without re-deriving them each time.

The workflow starts with `oclif generate command <topic>:<subtopic>:<verb>`
to create the command and test files, then replaces their contents with the
templates in templates/ (one per command shape, plus a test template).

References cover:
* flags.md - kebab-case flags mapped to camelCase API fields, the shared
  alias/org flags, exactlyOne id-or-name groups, and the reserved short chars
* testing.md - the Mocha/Chai/Sinon harness, and keeping suites to a limited
  set of tests covering core functionality rather than every permutation
* linting.md - verifying via npm test (posttest runs lint), and the
  perfectionist sort-objects/sort-union-types rules that fail most often
* openapi.md - spec URLs and mapping an operation to a command

Commands in this project follow the Solace Cloud OpenAPI specs at
https://api.solace.dev/cloud/page/openapi-specifications

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Wraps GET /api/v2/platform/users (Beta), which requires the iam_users:get
token permission.

Supports the endpoint's filters: --name and --email match on partial
strings, and --id, --role, and --group are repeatable flags that map to the
ids, roles, and groups array query parameters. The query string is built
with URLSearchParams so repeated keys and encoding are handled correctly.

Paging uses the shared paginationFlags/fetchPages/createTableWriter
helpers, so --all streams rows as each page arrives.

The README is left to the release flow; regenerating it now would also
sweep in unrelated broker plugin version drift.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@dishantlangayan
dishantlangayan merged commit 3ffe49a into main Oct 26, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant