Skip to main content
List and inspect the users in the organization.

describe

Describe a single user. Pass exactly one of --user-id or --user-email. Pass --user-id me for the authenticated user.

Options

TEXT
Filter JSON output with a jq expression; implies —output json (or jsonl for streamed commands)
TEXT
default:"text"
Output formatOne of: text, json, jsonl, none
TEXT
Use a specific stored profile for this command, overriding BASETEN_PROFILE and the current profile
TEXT
Email of the user to describe.Mutually exclusive with other flags in group user-ref.
TEXT
User ID to describe. Pass ‘me’ for the authenticated user.Mutually exclusive with other flags in group user-ref.
BOOL
Enable verbose logging

Examples

Describe the authenticated user
Describe a user by email

Filter output with --jq

Print the user’s email

Output

Text mode (--output text): Field-per-line summary of the user. JSON mode (--output json): payload type managementapi.UserInfo.

list

List the users in the organization.

Options

TEXT
Filter JSON output with a jq expression; implies —output json (or jsonl for streamed commands)
TEXT
default:"text"
Output formatOne of: text, json, jsonl, none
TEXT
Use a specific stored profile for this command, overriding BASETEN_PROFILE and the current profile
BOOL
Enable verbose logging

Examples

List all users in the org

Filter output with --jq

Print just the user emails

Output

Text mode (--output text): Table with columns: USER ID, EMAIL, NAME. When no users exist, prints “No users found.” to stderr. JSON mode (--output json): payload type cmd.OrgUserList.