Skip to content
ayx-rsv0.22.1

Person

ayx one person manages users in Alteryx One. It covers the full lifecycle: listing, creating, updating, deleting, and handling password resets. Mutating commands are dry-run by default; add --apply to commit. Password operations and deletes are sensitive — review dry-run output before adding --apply.

Quick reference

Section titled “Quick reference”
Command What it does
person list List all users
person current Show the user tied to the active profile
person detail <id> Show detail for a specific user
`person create –body <FILE JSON
`person update –body <FILE JSON
`person patch –body <FILE JSON
person delete <id> Delete a user
`person update-password –body <FILE JSON
`person password-reset-request –body <FILE JSON

Listing and inspecting users

Section titled “Listing and inspecting users”
Terminal window
# Paginated list
ayx one person list


# All users (auto-paginate)
ayx one person list --all


# Limit page size
ayx one person list --limit 100




# The authenticated caller
ayx one person current


# Specific user
ayx one person detail <id>


# Machine-readable
ayx -o json one person list --all

--profile <name> switches the target environment on commands that support it. Use --max-pages <n> to cap auto-pagination.

Creating a user

Section titled “Creating a user”
Terminal window
# Preview the request
ayx one person create --body '{"email":"<email>","firstName":"...","lastName":"..."}'


# Commit
ayx one person create \
  --body '{"email":"<email>","firstName":"...","lastName":"..."}' \
  --apply

Pass --profile <name> to create in a specific environment.

Updating a user

Section titled “Updating a user”

update replaces the full record (PUT). patch applies partial changes (PATCH).

Terminal window
# Full replace (preview)
ayx one person update \
  <id> \
  --body '{"email":"<email>","firstName":"...","lastName":"..."}'


# Commit
ayx one person update \
  <id> \
  --body '{"email":"<email>","firstName":"...","lastName":"..."}' \
  --apply


# Partial update (patch a single field)
ayx one person patch \
  <id> \
  --body '{"firstName":"NewName"}' \
  --apply

Deleting a user

Section titled “Deleting a user”

Destructive. Review the dry-run output carefully before adding --apply.

Terminal window
# Preview
ayx one person delete <id>


# Commit
ayx one person delete <id> --apply --yes

--yes suppresses the TTY confirmation, required in CI or piped scripts.

Password management

Section titled “Password management”

Update current user’s password

Section titled “Update current user’s password”
Terminal window
# Preview (Bash: keep passwords out of command arguments)
cat password-change.json | ayx one person update-password --body -
# PowerShell equivalent:
# Get-Content -Raw password-change.json | ayx one person update-password --body -


# Commit
ayx one person update-password \
  --body password-change.json \
  --apply

Send a password reset email

Section titled “Send a password reset email”
Terminal window
# Preview
ayx one person password-reset-request --body '{"email":"<email>"}'


# Commit
ayx one person password-reset-request \
  --body '{"email":"<email>"}' \
  --apply

This sends the reset email to the user. No --yes is required — it is not considered a destructive operation. For every --body flag, use a file, inline non-secret JSON, or - for piped stdin; inline values are visible in shell history and process listings.

Automation patterns

Section titled “Automation patterns”
Terminal window
# Export all users as JSON for auditing
ayx -o json one person list --all | jq '.data'


# Get a user's ID by email
ayx -o json one person list --all \
  | jq -r '.data[] | select(.email == "<email>") | .id'


# Bulk delete: pipe IDs into xargs (dry-run first)
ayx -o json one person list --all \
  | jq -r '.data[] | select(.someField == "value") | .id' \
  | xargs -I{} ayx one person delete {}


# Add --apply once the dry-run output looks right
Section titled “Related”