Skip to content
ayx-rsv0.15.0

Connection permissions

Connection permissions control which users and groups can use a given connection in Alteryx One. You can list, inspect, create, and delete permissions from the CLI. Mutating commands are dry-run by default — add --apply to commit.

Quick reference

Section titled “Quick reference”
Command What it does
ayx one connections permissions list List all permissions for a connection
ayx one connections permissions detail Inspect a single permission by subject ID
ayx one connections permissions create Grant a permission from a JSON payload
ayx one connections permissions delete Revoke a permission by subject ID

All commands accept <connection-id> as the connection positional argument and --profile <profile-id>.

Listing permissions

Section titled “Listing permissions”
Terminal window
# All permissions for a connection
ayx one connections permissions list <id>


# Scoped to a profile
ayx one connections permissions list <id> --profile <profile-id>


# Machine-readable output
ayx --output json one connections permissions list <id>

Inspecting a permission

Section titled “Inspecting a permission”

A subject is a user or group that has been granted access.

Terminal window
ayx one connections permissions detail \
  <id> \
  <subject-id>

Granting a permission

Section titled “Granting a permission”
Terminal window
# Dry-run
ayx one connections permissions create \
  <id> \
  --body '{"subjectId":"<subject-id>","role":"viewer"}'


# Commit
ayx one connections permissions create \
  <id> \
  --body '{"subjectId":"<subject-id>","role":"viewer"}' \
  --apply

The --body JSON structure depends on your Alteryx One version. Use ayx one connections permissions list on an existing connection to see the shape of current permission records.

Revoking a permission

Section titled “Revoking a permission”
Terminal window
# Dry-run
ayx one connections permissions delete \
  <id> \
  <subject-id>


# Commit (skips TTY prompt in CI)
ayx one connections permissions delete \
  <id> \
  <subject-id> \
  --apply --yes

Automation patterns

Section titled “Automation patterns”

Audit all subjects with access to a connection:

Terminal window
ayx --output json one connections permissions list <id> \
  | jq -r '.data[] | [.subjectId, .role] | @tsv'

Remove all permissions for a decommissioned user across multiple connections:

Terminal window
# First collect connection IDs
ayx --output json one connections list --all | jq -r '.data[].id' > conn-ids.txt


# Then revoke per connection where the subject appears
while read conn_id; do
  ayx --output json one connections permissions list "$conn_id" \
    | jq -r '.data[] | select(.subjectId == "<subject-id>") | .subjectId' \
    | grep -q . && \
    ayx one connections permissions delete \
      "$conn_id" \
      <subject-id> \
      --apply --yes
done < conn-ids.txt
Section titled “Related”