@wearableintelligence/plugin-admin-cli
v0.1.7
Published
parsable-cli plugin for admin functionality
Downloads
10
Readme
admin-cli
parsable-cli plugin for admin functionality
Test
You can run your local changes against staging environemnt by running
parsable-cli login
cp ~/.config/@wearableintelligence/parsable-cli/parsable-envs.json ~/.config/@wearableintelligence/plugin-admin-cli/
- You can run
./bin/run [command]
This is run in order to have the correct credentials from login since admin-cli does not have login section
Usage
$ npm install -g @wearableintelligence/plugin-admin-cli
$ parsable-cli COMMAND
running command...
$ parsable-cli (-v|--version|version)
@wearableintelligence/plugin-admin-cli/0.1.7 linux-x64 node-v14.18.1
$ parsable-cli --help [COMMAND]
USAGE
$ parsable-cli COMMAND
...
Commands
parsable-cli attributes:add
parsable-cli attributes:list
parsable-cli attributes:remove
parsable-cli params:add
parsable-cli params:list
parsable-cli params:update
parsable-cli policies:add
parsable-cli policies:list
parsable-cli settings:audit
parsable-cli settings:list
parsable-cli settings:update
parsable-cli settings:versions
parsable-cli teams:create
parsable-cli teams:delete
parsable-cli teams:disable
parsable-cli teams:enable
parsable-cli teams:fetch
parsable-cli teams:list
parsable-cli teams:provision-trial
parsable-cli teams:update
parsable-cli users:add
parsable-cli users:apply
parsable-cli users:assign
parsable-cli users:bulk:update
parsable-cli users:delete
parsable-cli users:grant
parsable-cli users:list
parsable-cli users:query
parsable-cli users:remove
parsable-cli users:revoke
parsable-cli users:show
parsable-cli users:tokens
parsable-cli users:unapply
parsable-cli users:unassign
parsable-cli users:update
parsable-cli attributes:add
Add new attribute values
USAGE
$ parsable-cli attributes:add
OPTIONS
-a, --attributes=attributes (required) Attribute and attribute values, formatted like key=value|value|value
-t, --team=team Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Use this command to add attribute values to a team, this is purely additive and will not remove any values. Attribute
input format is key=value|value|value
ALIASES
$ parsable-cli attrs:add
EXAMPLES
parsable-cli attributes:add -t my-team -a Location='San Francisco|Austin|Vancouver'
parsable-cli attributes:add --team a-squad -a 'Location'='Mexico City' -a 'Business Unit'='Food|Alcohol'
parsable-cli attrs:add -team team-b -a 'Location'='Berlin 1|Berlin 2' -a 'Business Function'='Planning|Operations'
See code: src/commands/attributes/add.js
parsable-cli attributes:list
List attribute values for a team
USAGE
$ parsable-cli attributes:list
OPTIONS
-t, --team=team Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
List the attribute and attribute values for a team.
ALIASES
$ parsable-cli attributes:ls
$ parsable-cli attrs:list
$ parsable-cli attrs:ls
EXAMPLES
parsable-cli attributes:list -t the-team
parsable-cli attributes:list --team the-team
parsable-cli attrs:list -t 577cf2ed-b5b9-4bd4-a09d-f4a6c2571c13
parsable-cli attrs:ls --team 577cf2ed-b5b9-4bd4-a09d-f4a6c2571c13
See code: src/commands/attributes/list.js
parsable-cli attributes:remove
Remove attribute values from a team
USAGE
$ parsable-cli attributes:remove
OPTIONS
-a, --attributes=attributes (required) Attribute and attribute values, formatted like key=value|value|value
-t, --team=team Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Remove one or many attribute values on a team. Attribute input format is key=value|value|value
ALIASES
$ parsable-cli attributes:archive
$ parsable-cli attributes:rm
$ parsable-cli attrs:remove
$ parsable-cli attrs:archive
$ parsable-cli attrs:rm
EXAMPLES
parsable-cli attributes:remove -t my-team -a Location='San Francisco|Austin|Vancouver'
parsable-cli attributes:archive --team a-squad -a 'Location'='Mexico City' -a 'Business Unit'='Food|Alcohol'
parsable-cli attrs:rm -team team-b -a 'Location'='Berlin 1|Berlin 2' -a 'Business Function'='Planning|Operations'
See code: src/commands/attributes/remove.js
parsable-cli params:add
Add Parameters
USAGE
$ parsable-cli params:add
OPTIONS
-O, --owner=ALL|JOB_TEMPLATE|STEP_GROUP|STEP|JOB|USER Parameter owner, will default to JOB_TEMPLATE if left out
-T, --type=TEXT|NUMBER|MULTI_SELECT_LIST|LIST (required) Parameter type
-d, --defaultValue=defaultValue Default value, if multi-select list, separate values by |
-k, --key=key (required) Parameter key name
-o, --options=options Sets options for list and multi select list types, separate
options by |
-r, --[no-]required Set flag if parameter is required, use --no-required if not
required
-t, --team=team Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Use this command to add parameters for a team
ALIASES
$ parsable-cli parameters:add
$ parsable-cli metadata:add
EXAMPLES
parsable-cli params:add -k 'Risk Level' -T TEXT -O STEP_GROUP -t corteva
parsable-cli params:add -k 'Color' -T LIST -d green -o 'green|red|blue|yellow'
parsable-cli params:add -k 'Shape' -T MULTI_SELECT_LIST -d 'big|round' --required
See code: src/commands/params/add.js
parsable-cli params:list
List parameters for a team
USAGE
$ parsable-cli params:list
OPTIONS
-a, --includeArchived Set this flag to include archived parameters in the response
-t, --team=team Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Use this command to view parameters (metadata) for a team
ALIASES
$ parsable-cli params:ls
$ parsable-cli parameters:list
$ parsable-cli parameters:ls
$ parsable-cli metadata:list
$ parsable-cli metadata:ls
EXAMPLES
parsable-cli params:list
parsable-cli parameters:ls
parsable-cli params:list -a
parsable-cli params:list --includeArchived
See code: src/commands/params/list.js
parsable-cli params:update
Update Parameters
USAGE
$ parsable-cli params:update
OPTIONS
-T, --type=TEXT|NUMBER|MULTI_SELECT_LIST|LIST Parameter type
-c, --clear-default Set this flag to clear the default value
-d, --default-value=default-value Default value, if multi-select list, separate values by |
-k, --key=key Parameter key name to update
-p, --parameterId=parameterId (required) Parameter ID
-r, --[no-]required Mark parameter as required, use --no-required if not required
-s, --sort-list Sorts list options alphabetically, this only works for list and multi
select list types
-t, --team=team Team ID or subdomain the request is for
--add-options=add-options Adds options for list and multi select list types, separate options by
"|"
--remove-options=remove-options Removes options for list and multi select list types, separate options
by "|", returns error if any option does not match the current ones
--rename-options=rename-options Renames options for list and multi select list types, separate obtions
by "|" and the new value with ":", returns error if any option does
snot match the current ones
DESCRIPTION
...
Use this command to update parameters for a team
ALIASES
$ parsable-cli parameters:update
$ parsable-cli metadata:update
EXAMPLES
parsable-cli params:update -p 3f83a5f7-6615-48d8-b520-4018b551ffa3 -k "Risk Level"
parsable-cli params:update -p 2cdc5ba0-0a06-4958-8f79-eb53300d357a -t LIST -d green -a "green|red|blue|yellow"
--sort-list
parsable-cli params:update -p 2cdc5ba0-0a06-4958-8f79-eb53300d357a -T MULTI_SELECT_LIST -d "big|round" --add-options
"big|small|round|square"
parsable-cli params:update -p 2cdc5ba0-0a06-4958-8f79-eb53300d357a -T MULTI_SELECT_LIST --remove-options="big|small"
parsable-cli params:update -p 2cdc5ba0-0a06-4958-8f79-eb53300d357a -T MULTI_SELECT_LIST -d "big|round"
--rename-options="pink:red|circle:rounded"
parsable-cli params:update -p c72d37ff-07b3-4d46-a00a-de48784e13ed --required
parsable-cli params:update -p c72d37ff-07b3-4d46-a00a-de48784e13ed --no-required
parsable-cli params:update -p c72d37ff-07b3-4d46-a00a-de48784e13ed --clear-default
See code: src/commands/params/update.js
parsable-cli policies:add
Add new team policies
USAGE
$ parsable-cli policies:add
OPTIONS
-a, --action=VIEW|CREATE|EDIT|EXECUTE|PUBLISH|COLLABORATE|ARCHIVE
-e, --expression=expression
-o,
--object=USER|TEAM|JOB|JOB_TEMPLATE|TEMPLATE_SET|ISSUE|DATASHEET|POLICY|POLICY_SET|WORKFLOW|ANALYTICS|TEAM_SETTINGS|IN
TEGRATION_TEMPLATE|METADATA|METADATA_VALUE|ANALYTICS_2|IT_SETTINGS
-p, --policy=policy
-s,
--subject=USER|TEAM|JOB|JOB_TEMPLATE|TEMPLATE_SET|ISSUE|DATASHEET|POLICY|POLICY_SET|WORKFLOW|ANALYTICS|TEAM_SETTINGS|I
NTEGRATION_TEMPLATE|METADATA|METADATA_VALUE|ANALYTICS_2|IT_SETTINGS
-t, --team=team
Team ID or subdomain the request is for
-x, --extended
show extra columns
--columns=columns
only show provided columns (comma-separated)
--csv
output is csv format [alias: --output=csv]
--filter=filter
filter property by partial string matching, ex: name=foo
--no-header
hide table header from output
--no-truncate
do not truncate output to fit screen
--output=csv|json|yaml
output in a more machine friendly format
--sort=sort
property to sort by (prepend '-' for descending)
DESCRIPTION
...
Add one or many team policies. Use the policy flag if you want to add multiple policies with the same command. If
adding a single policy, you may use the combination of subject, object, action, and expression flags.
EXAMPLES
parsable-cli policies:add -t mikes-team --policy 'p,USER,ANALYTICS_2,role_admin,VIEW'
parsable-cli policies:add -t myteam --policy 'p,USER,ANALYTICS_2,role_admin,VIEW' --policy
'p,USER,ANALYTICS_2,role_admin,CREATE'
parsable-cli policies:add -t 42d2b7b8-1f8d-4dc7-8fcc-328dd3ac9e0b --subject USER --object TEAM_SETTINGS --action VIEW
--expression role_admin
See code: src/commands/policies/add.js
parsable-cli policies:list
List all team policies
USAGE
$ parsable-cli policies:list
OPTIONS
-t, --team=team Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Retrieve a list of all policies for a team.
EXAMPLES
parsable-cli policies:list -t team-name
parsable-cli policies:list -t 95c9044c-39e9-42e2-93d0-4ba001981409
parsable-cli policies:list --team team-one
See code: src/commands/policies/list.js
parsable-cli settings:audit
Setting Changes
USAGE
$ parsable-cli settings:audit
OPTIONS
-s, --settingId=settingId Setting ID
DESCRIPTION
...
See all changes made for a specific feature flag or parameter
ALIASES
$ parsable-cli settings:changes
EXAMPLES
parsable-cli settings:audit -s abac
parsable-cli settings:audit -s analyticsR2
parsable-cli settings:audit -s attributeOrdering
See code: src/commands/settings/audit.js
parsable-cli settings:list
List settings for a team
USAGE
$ parsable-cli settings:list
OPTIONS
-t, --team=team Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Use this command to view feature flags and parameters for a team
ALIASES
$ parsable-cli settings:ls
EXAMPLES
parsable-cli settings:list
parsable-cli settings:ls
parsable-cli settings:list --filter='type=Feature Flag'
parsable-cli settings:list --sort=-type
See code: src/commands/settings/list.js
parsable-cli settings:update
Update Team Settings
USAGE
$ parsable-cli settings:update
OPTIONS
-V, --value=value Update setting with this value
-d, --disable Disable a feature flag
-e, --enable Enable a feature flag
-m, --commit-msg=commit-msg [default: Updated via parsable-cli] Summarize your changes
-s, --settingId=settingId (required) Setting ID
-t, --team=team Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Use this command to toggle feature flags or update parameters for a team
EXAMPLES
parsable-cli settings:update -s workflow --disable
parsable-cli settings:update -s locale -V en-US
parsable-cli settings:update -t shell -s multiPhoto -V true
parsable-cli settings:update -t shell -s multiPhoto --enable -m 'Turning multi photo on for Shell'
See code: src/commands/settings/update.js
parsable-cli settings:versions
Setting Rule Versions
USAGE
$ parsable-cli settings:versions
OPTIONS
-t, --team=team Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
This command will provide a change log of any feature flags or parameter changes on a team
EXAMPLES
parsable-cli settings:versions
parsable-cli settings:versions -t honeywell
parsable-cli settings:versions -t halliburton -x
See code: src/commands/settings/versions.js
parsable-cli teams:create
Create a new Parsable team
USAGE
$ parsable-cli teams:create
OPTIONS
-n, --name=name (required) The team display name
-r, --region=us-west-2|eu-west-1 The region the team resides in
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Use this command to create a new Parsable team. You will be the owner of the team and will be able to invite others to
it.
EXAMPLES
parsable-cli teams:create -n 'New Team'
parsable-cli teams:create -n 'My New Team' -r us-west-2
parsable-cli teams:create --name 'The Newest Team' --region eu-west-1
See code: src/commands/teams/create.js
parsable-cli teams:delete
Delete a Parsable team and all related data
USAGE
$ parsable-cli teams:delete
OPTIONS
-f, --force Delete the team without confirmation prompt
-t, --team=team (required) Team ID or subdomain the request is for
DESCRIPTION
...
Use this command cautiously, this cannot be undone. All team data will be deleted from Parsable and cannot be
recovered.
EXAMPLES
parsable-cli teams:delete -t 07fd7d69-52b8-4375-a1a0-ce1a0788fd45
parsable-cli teams:delete --team e6cdd62d-36e0-43ba-9df0-c7bbdde28584
See code: src/commands/teams/delete.js
parsable-cli teams:disable
Disable a Parsable team
USAGE
$ parsable-cli teams:disable
OPTIONS
-t, --team=team (required) Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Use this command to disable a team. Once a team is disabled, it can no longer be accessed until enabled again.
EXAMPLES
parsable-cli teams:disable -t test-team
parsable-cli teams:disable -t cbc2141b-b084-4f8f-944a-d4349ae244e7
parsable-cli teams:disable --team 45d94ba2-439c-4398-a2b9-767a55dc3b30
See code: src/commands/teams/disable.js
parsable-cli teams:enable
Enable a Parsable team
USAGE
$ parsable-cli teams:enable
OPTIONS
-t, --team=team (required) Team ID the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
This command will enable a team that has been disabled. Team ID must be passed in, this will not work with only
passing in the subdomain.
EXAMPLES
parsable-cli teams:enable -t 79b4d6b5-8ad5-43a1-a37b-a8d0089d2fca
parsable-cli teams:enable --teamId 6625c0c1-8b8c-4f5b-a78d-89b94471ce69
See code: src/commands/teams/enable.js
parsable-cli teams:fetch
Fetch a team
USAGE
$ parsable-cli teams:fetch
OPTIONS
-t, --team=team Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Fetch a team by Team ID or Subdomain
ALIASES
$ parsable-cli teams:get
$ parsable-cli teams:show
$ parsable-cli teams:info
EXAMPLES
parsable-cli teams:fetch -t purple-monkeys
parsable-cli teams:fetch -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: src/commands/teams/fetch.js
parsable-cli teams:list
Lists all teams you have access to
USAGE
$ parsable-cli teams:list
OPTIONS
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
This command will list all teams that your logged in user has access to.
ALIASES
$ parsable-cli teams:ls
EXAMPLES
parsable-cli teams:list
parsable-cli teams:ls
See code: src/commands/teams/list.js
parsable-cli teams:provision-trial
Provision a trial team
USAGE
$ parsable-cli teams:provision-trial
OPTIONS
-e, --email=email (required) The email of the trial user
-r, --region=region The region the team resides in (us-west-2|eu-west-1)
-t, --team-name=team-name (required) The name of the team for the trial user
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Sends a request to provision a trial team.
EXAMPLE
parsable-cli teams:provision-trial [email protected] -r=us-west-2 -t='The Trial Team'
See code: src/commands/teams/provision-trial.js
parsable-cli teams:update
Update a Parsable team
USAGE
$ parsable-cli teams:update
OPTIONS
-T, --trial=on|off Turn on/off trial status for a team
-d, --disable Disable a team
-e, --enable Enable a team
-n, --name=name The team display name
-s, --subdomain=subdomain The team subdomain
-t, --team=team (required) Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Use this command to update a team. The team name, subdomain, and trial status may be updated. You may also enable or
disable a team.
ALIASES
$ parsable-cli teams:edit
EXAMPLES
parsable-cli teams:update -t my-team -n new-team-name -s new-subdomain
parsable-cli teams:update --team my-team --name just-another-team
parsable-cli teams:update -t my-team --disable
parsable-cli teams:update -t 1d0fef4c-3d7b-4315-bced-3cf5d0cd25ef --enable
parsable-cli teams:update -t my-team --trial off
parsable-cli teams:update -t dd9761cb-0b67-4085-952e-f532b8b4500b --trial on
See code: src/commands/teams/update.js
parsable-cli users:add
Add a user to a team
USAGE
$ parsable-cli users:add
OPTIONS
-P, --password=password
-e, --email=email
Email address of user
-r,
--roles=ADMIN|AUTHOR|JOBCREATOR|EXECUTOR|PARSABLE_ADMIN|WORKFLOW_PLANNER|ANALYTICS_EDITOR|ANALYTICS_VIEWER|IT_ADMIN
Team roles
-t, --team=team
Team ID or subdomain the request is for
-u, --username=username
Username or user id
--mail
Set flag to invite user by mail
DESCRIPTION
...
Use the password flag to create a user with a temporary password.
IMPORTANT - you can only create a temporary password if the user is not already a Parsable user, if the user has
already been created in Parsable the password will be ignored.
Set --mail flag to invite the user by email. You must be on the team to invite the user by mail.
EXAMPLES
parsable-cli users:add -t yara -u lwhittle -e [email protected] -r PARSABLE_ADMIN -r ADMIN -r AUTHOR
parsable-cli users:add -u bgaffney -e [email protected] -r PARSABLE_ADMIN -r ADMIN -P Pass1234!
parsable-cli users:add -e [email protected] -r PARSABLE_ADMIN -r ADMIN --mail
See code: src/commands/users/add.js
parsable-cli users:apply
Apply attributes to a user
USAGE
$ parsable-cli users:apply
OPTIONS
-a, --attributes=attributes Attribute and attribute values, formatted like key=value|value|value
-t, --team=team Team ID or subdomain the request is for
-u, --username=username Username or user id
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Adds the attribute and attributes values to a user. This command is additive.
Attribute values are separated by |
Roles cannot be applied here, you must use the users:assign command to add Roles.
ALIASES
$ parsable-cli users:applyAttributes
EXAMPLE
parsable-cli users:apply -t onboarding -u [email protected] -a 'Location=San Francisco|Austin' -a 'Business
Unit=Chicken|Kombucha'
See code: src/commands/users/apply.js
parsable-cli users:assign
Assign team roles to a user
USAGE
$ parsable-cli users:assign
OPTIONS
-r,
--roles=ADMIN|AUTHOR|JOBCREATOR|EXECUTOR|PARSABLE_ADMIN|WORKFLOW_PLANNER|ANALYTICS_EDITOR|ANALYTICS_VIEWER|IT_ADMIN
Team roles
-t, --team=team
Team ID or subdomain the request is for
-u, --username=username
Username or user id
DESCRIPTION
...
Adds team roles to a user. This command is additive.
ALIASES
$ parsable-cli users:assignRoles
EXAMPLES
parsable-cli users:assign -t onboarding -u [email protected] -r ADMIN -r PARSABLE_ADMIN
parsable-cli users:assign -u afb7b786-fddd-4a5e-9df3-a44eba144b85 -t heineken -r EXECUTOR
See code: src/commands/users/assign.js
parsable-cli users:bulk:update
Update users in bulk from a CSV
USAGE
$ parsable-cli users:bulk:update
OPTIONS
-f, --file=file (required) Path to the CSV file
DESCRIPTION
...
The CSV MUST have a header row that includes columns "id", "name", and "email".
The "id" and "name" are required, "email" is optional.
Save the CSV to your hard drive, then pass the path to the CSV with the --file flag
Example CSV
id, name, email
12c31f28-2f14-4c13-a6e4-90129ec96833, George Foreman, [email protected]
b6e7596f-1178-435b-ad3e-d06f7fda87e9, Mike Tyson, [email protected]
EXAMPLES
parsable-cli users:bulk:update -f input/updateUsers.csv
parsable-cli users:bulk:update -f /Users/username/parsable/update.csv
See code: src/commands/users/bulk/update.js
parsable-cli users:delete
Deletes a user from a team
USAGE
$ parsable-cli users:delete
OPTIONS
-t, --team=team Team ID or subdomain the request is for
-u, --username=username Username or user id
DESCRIPTION
...
WARNING: This command will completely delete a user from the team and remove all of their roles and attributes.
They will not show in the archived users list.
See code: src/commands/users/delete.js
parsable-cli users:grant
Grants a user a persistent auth token
USAGE
$ parsable-cli users:grant
OPTIONS
-u, --username=username (required) Username or user id
DESCRIPTION
...
Creates a persistent auth token for a user. A user can only have one persistent auth token at any given time.
EXAMPLES
parsable-cli users:grant -u [email protected]
parsable-cli users:grant -u afb7b786-fddd-4a5e-9df3-a44eba144b85
See code: src/commands/users/grant.js
parsable-cli users:list
Lists users on a team
USAGE
$ parsable-cli users:list
OPTIONS
-a, --attributes=attributes
Attribute and attribute values, formatted like key=value|value|value
-p, --paging=paging
Paging for querying, in the format {page}:{limit}. The limit is the number of results per page and the page is how
many pages to “skip” over before starting to return results.
-r,
--roles=ADMIN|AUTHOR|JOBCREATOR|EXECUTOR|PARSABLE_ADMIN|WORKFLOW_PLANNER|ANALYTICS_EDITOR|ANALYTICS_VIEWER|IT_ADMIN
Team roles
-t, --team=team
Team ID or subdomain the request is for
-x, --extended
show extra columns
--all
Set flag to list all users on the team
--columns=columns
only show provided columns (comma-separated)
--csv
output is csv format [alias: --output=csv]
--filter=filter
filter property by partial string matching, ex: name=foo
--no-header
hide table header from output
--no-truncate
do not truncate output to fit screen
--output=csv|json|yaml
output in a more machine friendly format
--sort=sort
property to sort by (prepend '-' for descending)
DESCRIPTION
...
Use this command to query users on a team by roles and attributes. Supports paging.
ALIASES
$ parsable-cli users:ls
EXAMPLES
parsable-cli users:list -t halliburton
parsable-cli users:list -t d364a4aa-ef06-4848-9af3-ad1bf6f01dc7
parsable-cli users:list -t corteva -r EXECUTOR
parsable-cli users:list -t afb7b786-fddd-4a5e-9df3-a44eba144b85 -a Role=AUTHOR
parsable-cli users:list -t afb7b786-fddd-4a5e-9df3-a44eba144b85 -r PARSABLE_ADMIN -a Location=Austin
parsable-cli users:list -t afb7b786-fddd-4a5e-9df3-a44eba144b85 --all
See code: src/commands/users/list.js
parsable-cli users:query
Query for users across teams or within a specific team
USAGE
$ parsable-cli users:query
OPTIONS
-n, --name=name (required) Name or partial name to query
-t, --team=team Leave blank to query across all teams, add to query within a specific team
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Enter a name or partial name to query across all teams, or add the team flag to query within a specific team
ALIASES
$ parsable-cli users:find
EXAMPLES
parsable-cli users:query -n mike
parsable-cli users:query --name michael
parsable-cli users:query -n michael -t the-a-team
See code: src/commands/users/query.js
parsable-cli users:remove
Removes a user from a team
USAGE
$ parsable-cli users:remove
OPTIONS
-t, --team=team Team ID or subdomain the request is for
-u, --username=username Username or user id
DESCRIPTION
...
This command removes all roles for a user on a given team.
ALIASES
$ parsable-cli users:removeUserFromTeam
$ parsable-cli users:rm
EXAMPLES
parsable-cli users:remove -t halliburton -u [email protected]
parsable-cli users:remove -t d364a4aa-ef06-4848-9af3-ad1bf6f01dc7 -u c08a5391-3798-469c-a156-8bd333a54db0
parsable-cli users:rm -u [email protected] -t 2bf8a711-1404-4467-9fe7-ead62b5f04ea
See code: src/commands/users/remove.js
parsable-cli users:revoke
Revoke a persistent auth token
USAGE
$ parsable-cli users:revoke
OPTIONS
-u, --username=username (required) Username or user id
DESCRIPTION
...
Revokes a persistent auth token for a user. The persistent auth token will no longer by valid to use.
EXAMPLES
parsable-cli users:revoke -u [email protected]
parsable-cli users:revoke -u d364a4aa-ef06-4848-9af3-ad1bf6f01dc7
See code: src/commands/users/revoke.js
parsable-cli users:show
Show user information
USAGE
$ parsable-cli users:show
OPTIONS
-t, --team=team Team ID or subdomain the request is for
-u, --username=username Username or user id
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Use this command to view a specific user's information
ALIASES
$ parsable-cli users:get
$ parsable-cli users:fetch
EXAMPLES
parsable-cli users:show -u [email protected]
parsable-cli users:show -u bfd373c2-efe5-4251-a81e-c16d63f01377
parsable-cli users:show -u [email protected] -t wacker
parsable-cli users:show -u [email protected] -t d364a4aa-ef06-4848-9af3-ad1bf6f01dc7
See code: src/commands/users/show.js
parsable-cli users:tokens
View team tokens
USAGE
$ parsable-cli users:tokens
OPTIONS
-t, --team=team Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Lists all auth tokens granted to users on a team
EXAMPLES
parsable-cli users:tokens -t c53149e5-931a-48b8-9f2a-9f079d47e3cc
parsable-cli users:tokens -t heineken
See code: src/commands/users/tokens.js
parsable-cli users:unapply
Remove attributes on a user
USAGE
$ parsable-cli users:unapply
OPTIONS
-a, --attributes=attributes Attribute and attribute values, formatted like key=value|value|value
-t, --team=team Team ID or subdomain the request is for
-u, --username=username (required) Username or user id
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Removes the attributes values applied a user.
Attribute values are separated by |
Roles cannot be applied here, you must use the users:unassign command to remove Roles.
ALIASES
$ parsable-cli users:unapplyAttributes
EXAMPLE
parsable-cli users:unapply -t onboarding -u [email protected] -a 'Location=San Francisco|Austin' -a 'Business
Unit=Chicken|Kombucha'
See code: src/commands/users/unapply.js
parsable-cli users:unassign
Remove team roles from a user
USAGE
$ parsable-cli users:unassign
OPTIONS
-r,
--roles=ADMIN|AUTHOR|JOBCREATOR|EXECUTOR|PARSABLE_ADMIN|WORKFLOW_PLANNER|ANALYTICS_EDITOR|ANALYTICS_VIEWER|IT_ADMIN
Team roles
-t, --team=team
Team ID or subdomain the request is for
-u, --username=username
Username or user id
DESCRIPTION
...
Removes team roles from a user.
ALIASES
$ parsable-cli users:unassignRoles
EXAMPLES
parsable-cli users:unassign -t onboarding -u [email protected] -r ADMIN -r PARSABLE_ADMIN
parsable-cli users:unassign -u afb7b786-fddd-4a5e-9df3-a44eba144b85 -t heineken -r EXECUTOR
See code: src/commands/users/unassign.js
parsable-cli users:update
Update the name or email of a user
USAGE
$ parsable-cli users:update
OPTIONS
-U, --userId=userId (required) User id
-e, --email=email Email address of user
-n, --name=name (required) Name
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Update the name or email of a user. Name changes will be applied instantly.
Email changes will need to be accepted by the user, an email will be sent to their old email address to confirm.
To update a user, you must either have an ADMIN role on a shared team or have Parsable super admin privileges.
The userId flag is required to update a user along with name, email is optional.
EXAMPLES
parsable-cli users:update -U d364a4aa-ef06-4848-9af3-ad1bf6f01dc7 -n 'Jonathan Doe' -e '[email protected]'
parsable-cli users:update -U d364a4aa-ef06-4848-9af3-ad1bf6f01dc7 -n 'John Doe'
See code: src/commands/users/update.js