❤
npm
Sign UpSign In

pliancy-cli
TypeScript icon, indicating that this package has built-in type declarations

3.0.5 • Public • Published

pliancy-cli

Pliancy CLI

Actions Status oclif Version Downloads/week License

Usage

$ npm install -g pliancy-cli
$ pliancy-cli COMMAND
running command...
$ pliancy-cli (-v|--version|version)
pliancy-cli/2.27.1 linux-x64 node-v14.21.3
$ pliancy-cli --help [COMMAND]
USAGE
  $ pliancy-cli COMMAND
...

Commands

pliancy-cli appcatalog:add APPID PERMISSIONS DEFAULTPERMISSION [DESCRIPTION]

create an app in the catalog

USAGE
  $ pliancy-cli appcatalog:add APPID PERMISSIONS DEFAULTPERMISSION [DESCRIPTION]

ARGUMENTS
  APPID              the pliancy appId to create
  PERMISSIONS        one or more comma separated permission levels
  DEFAULTPERMISSION  the default permission for the app
  DESCRIPTION        optional description for the app

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLE
  $ pliancy-cli appcatalog:add OFFICE365 E3,EOP1 E3 "a good 365 app"
  { App JSON Object }

See code: commands/appcatalog/toggle.ts

pliancy-cli appcatalog:get [APPID]

get all/one app(s)

USAGE
  $ pliancy-cli appcatalog:get [APPID]

ARGUMENTS
  APPID  the pliancy appId to find

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLE
  $ pliancy-cli appcatalog:get OFFICE365
  { App JSON Object }

See code: commands/appcatalog/get.ts

pliancy-cli appcatalog:permissions:add APPID PERMISSIONS

add an additional app permission to an existing application

USAGE
  $ pliancy-cli appcatalog:permissions:add APPID PERMISSIONS

ARGUMENTS
  APPID        the pliancy appId
  PERMISSIONS  one or more comma separated permission levels

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLE
  $ pliancy-cli appcatalog:permissions:add AWSLIV "POWER USER"
  { App JSON Object }

See code: commands/appcatalog/permissions/toggle.ts

pliancy-cli appcatalog:permissions:remove APPID PERMISSION

removes an app permission to an existing application

USAGE
  $ pliancy-cli appcatalog:permissions:remove APPID PERMISSION

ARGUMENTS
  APPID       the pliancy appId
  PERMISSION  permission level to remove

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLE
  $ pliancy-cli appcatalog:permissions:remove AWSLIV "BAD USER"
  { App JSON Object }

See code: commands/appcatalog/permissions/remove.ts

pliancy-cli appcatalog:permissions:set-default APPID DEFAULTPERMISSION

sets the default permission on an existing application

USAGE
  $ pliancy-cli appcatalog:permissions:set-default APPID DEFAULTPERMISSION

ARGUMENTS
  APPID              the pliancy appId
  DEFAULTPERMISSION  the permission level to be set as default

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLE
  $ pliancy-cli appcatalog:permissions:set-default AWSLIV "POWER USER"
  { App JSON Object }

See code: commands/appcatalog/permissions/set-default.ts

pliancy-cli appcatalog:remove APPID

remove an app from the catalog

USAGE
  $ pliancy-cli appcatalog:remove APPID

ARGUMENTS
  APPID  the pliancy appId to remove

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLE
  $ pliancy-cli appcatalog:remove MYBADAPP
  { App JSON Object }

See code: commands/appcatalog/remove.ts

pliancy-cli auth:get TYPE

Get current auth information

USAGE
  $ pliancy-cli auth:get TYPE

ARGUMENTS
  TYPE  (apikey|saml) type of auth to get

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

See code: commands/auth/get.ts

pliancy-cli auth:get-role

Inspects current roles you have locally

USAGE
  $ pliancy-cli auth:get-role

See code: commands/auth/get-role.ts

pliancy-cli auth:refresh-role

Refresh your locally cached role

USAGE
  $ pliancy-cli auth:refresh-role

See code: commands/auth/refresh-role.ts

pliancy-cli auth:set TYPE

Authenticate with the Pliancy API

USAGE
  $ pliancy-cli auth:set TYPE

ARGUMENTS
  TYPE  (apikey|saml) [default: saml] type of auth to setup

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

See code: commands/auth/set.ts

pliancy-cli conf [KEY] [VALUE]

manage configuration

USAGE
  $ pliancy-cli conf [KEY] [VALUE]

ARGUMENTS
  KEY    key of the config
  VALUE  value of the config

OPTIONS
  -d, --cwd=cwd          config file location
  -d, --delete           delete?
  -h, --help             show CLI help
  -k, --key=key          key of the config
  -n, --name=name        config file name
  -p, --project=project  project name
  -v, --value=value      value of the config

See code: conf-cli

pliancy-cli customers:activation CUSTOMERID

send BATCH activations for a customer

USAGE
  $ pliancy-cli customers:activation CUSTOMERID

ARGUMENTS
  CUSTOMERID  the pliancy customerId to send activations to

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  -r, --sendToRecoveryAddress  Send to the recovery email address for the user instead of the primary email
  -t, --templateId=templateId  the template id from postmark
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLE
  $ pliancy-cli customers:activation ABC
  { User JSON Object }

See code: commands/customers/activation.ts

pliancy-cli customers:add CUSTOMERID NAME PRIMARYDOMAIN

create a customer

USAGE
  $ pliancy-cli customers:add CUSTOMERID NAME PRIMARYDOMAIN

ARGUMENTS
  CUSTOMERID     the customerId for the new customer
  NAME           the friendly name for the customer
  PRIMARYDOMAIN  The primary dns domain for the customer

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLE
  $ pliancy-cli customers:add LIV "Lorem Ipsum Ventures" loremipsumventures.com
  { Customer JSON Object }

See code: commands/customers/toggle.ts

pliancy-cli customers:apps:add [CUSTOMERID] [APPS]

add customer apps

USAGE
  $ pliancy-cli customers:apps:add [CUSTOMERID] [APPS]

ARGUMENTS
  CUSTOMERID  the customerId of the customer
  APPS        'a valid JSON array of new apps to add, surrounded by single ticks ('[]')'

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLE
  $ pliancy-cli customers:apps:add LIV '[{"appId": "APP1", "data": { "clientId": "clientId", "clientSecret": 
  "clientSecret" }}]'

See code: commands/customers/apps/toggle.ts

pliancy-cli customers:apps:remove [CUSTOMERID] [APPIDS]

remove customer apps

USAGE
  $ pliancy-cli customers:apps:remove [CUSTOMERID] [APPIDS]

ARGUMENTS
  CUSTOMERID  the customerId of the customer
  APPIDS      A comma-separated string of app IDs

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLE
  $ pliancy-cli customers:apps:remove LIV 'APP1,APP2,APP3'

See code: commands/customers/apps/remove.ts

pliancy-cli customers:apps:update [CUSTOMERID] [APP]

edit a customer app

USAGE
  $ pliancy-cli customers:apps:update [CUSTOMERID] [APP]

ARGUMENTS
  CUSTOMERID  the customerId of the customer
  APP         An app in valid JSON format, including appId and any data properties you wish to update

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLE
  $ pliancy-cli customers:apps:update LIV '{"appId": "APP", "data": {"clientId": "newClientId"}}

See code: commands/customers/apps/update.ts

pliancy-cli customers:branding:get CUSTOMERID

Get brand data for customer

USAGE
  $ pliancy-cli customers:branding:get CUSTOMERID

ARGUMENTS
  CUSTOMERID  the customerId of the customer to change branding for

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLE
  $ pliancy-cli customers:branding:get LIV

See code: commands/customers/branding/get.ts

pliancy-cli customers:branding:set CUSTOMERID ATTRIBUTE VALUE

Update brand data for customer

USAGE
  $ pliancy-cli customers:branding:set CUSTOMERID ATTRIBUTE VALUE

ARGUMENTS
  CUSTOMERID  the customerId of the customer to change branding for
  ATTRIBUTE   the branding attribute to change [ emailSubject | emailTemplateId ]
  VALUE       value to set for the setting

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLES
  $ pliancy-cli customers:branding:set LIV emailSubject "Welcome {{firstName}} to the family of 
  {{organizationFriendlyName}}!!!"

  $ pliancy-cli customers:branding:set LIV emailTemplateId "13243546"

See code: commands/customers/branding/set.ts

pliancy-cli customers:get [CUSTOMERID]

get all/one customers

USAGE
  $ pliancy-cli customers:get [CUSTOMERID]

ARGUMENTS
  CUSTOMERID  the pliancy customerId to find

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLE
  $ pliancy-cli customers:get ABC
  { Customer JSON Object }

See code: commands/customers/get.ts

pliancy-cli customers:remove CUSTOMERID

remove a customer

USAGE
  $ pliancy-cli customers:remove CUSTOMERID

ARGUMENTS
  CUSTOMERID  the customerId for the new customer

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLE
  $ pliancy-cli customers:remove LIV

See code: commands/customers/remove.ts

pliancy-cli customers:set [CUSTOMERID] [ATTRIBUTE] [VALUE]

update a customer

USAGE
  $ pliancy-cli customers:set [CUSTOMERID] [ATTRIBUTE] [VALUE]

ARGUMENTS
  CUSTOMERID  the customerId of the customer
  ATTRIBUTE   top level attribute to set
  VALUE       value for the attribute (arrays need to be comma seperated, see examples)

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --from-csv=./example.csv     CSV file path to import users from
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLE
  $ pliancy-cli customers:set LIV name "Cool Customer"

See code: commands/customers/set.ts

pliancy-cli devices:get [CUSTOMERID]

Gets All Addigy and Intune Devices with Sophos Status

USAGE
  $ pliancy-cli devices:get [CUSTOMERID]

ARGUMENTS
  CUSTOMERID  The Pliancy customerId of customer

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  -w, --waste                  Only display devices that haven't checked in for 30+ days
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLE
  $ pliancy-cli devices:get customerId

See code: commands/devices/get.ts

pliancy-cli endpointmgmt:addigy:certs:get [CUSTOMERID]

Gets all Addigy APNS Certificates for Customer(s)

USAGE
  $ pliancy-cli endpointmgmt:addigy:certs:get [CUSTOMERID]

ARGUMENTS
  CUSTOMERID  The Pliancy customerId of customer

OPTIONS
  -A, --all                          show all columns in table view
  -C, --csv                          output in csv format
  -J, --json                         output in json format
  -Y, --yaml                         output in yaml format
  -e, --expiresWithin=expiresWithin  Filter in Days for upcoming Expirations
  -h, --help                         show CLI help
  --filter=filter                    filter on column (key=value)
  --table-output=table-output        output for table view. [csv, yaml, json]

EXAMPLES
  $ pliancy-cli endpoint:addigy:certs:get customerId
  $ pliancy-cli endpoint:addigy:certs:get
  $ pliancy-cli endpoint:addigy:certs:get customerId -e=60

See code: commands/endpointmgmt/addigy/certs/get.ts

pliancy-cli endpointmgmt:sophos:encryptionkeys:set CUSTOMERID

Gets and Stores Sophos Keys for a Customer

USAGE
  $ pliancy-cli endpointmgmt:sophos:encryptionkeys:set CUSTOMERID

ARGUMENTS
  CUSTOMERID  The Pliancy customerId of customer

OPTIONS
  -A, --all                            show all columns in table view
  -C, --csv                            output in csv format
  -J, --json                           output in json format
  -Y, --yaml                           output in yaml format
  -h, --help                           show CLI help
  -s, --sophosDeviceId=sophosDeviceId  Only get encryption keys for specific device
  --filter=filter                      filter on column (key=value)
  --table-output=table-output          output for table view. [csv, yaml, json]

EXAMPLES
  $ pliancy-cli endpointmgmt:sophos:encryptionkeys:set customerId
  $ pliancy-cli endpointmgmt:sophos:encryptionkeys:set customerId --sophosDeviceId=12345

See code: commands/endpointmgmt/sophos/encryptionkeys/set.ts

pliancy-cli eng:migrations:check-users CUSTOMERID

check for mismatches between pliancy users & app users

USAGE
  $ pliancy-cli eng:migrations:check-users CUSTOMERID

ARGUMENTS
  CUSTOMERID  the pliancy customerId to grab users from

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --ad=ad                      csv file for active directory users
  --box=box                    csv file for box users
  --dropbox=dropbox            csv file for dropbox users
  --egnyte=egnyte              csv file for egnyte users
  --filter=filter              filter on column (key=value)
  --gsuite=gsuite              csv file for g suite users
  --lastpass=lastpass          csv file for lastpass users
  --office365=office365        csv file for office 365 users
  --slack=slack                csv file for slack users
  --table-output=table-output  output for table view. [csv, yaml, json]
  --zoom=zoom                  csv file for zoom users

EXAMPLE
  $ pliancy-cli eng:migrations:check-users LIV --office365=PATH_TO_FILE.csv

See code: commands/eng/migrations/check-users.ts

pliancy-cli help [COMMAND]

display help for pliancy-cli

USAGE
  $ pliancy-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

pliancy-cli permissions:get [CUSTOMERID]

get all permissions (with optional customer filter)

USAGE
  $ pliancy-cli permissions:get [CUSTOMERID]

ARGUMENTS
  CUSTOMERID  the pliancy customerId or userId to get permissions for

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLE
  $ pliancy-cli permissions:get ABC
  { User JSON Object }

See code: commands/permissions/get.ts

pliancy-cli permissions:remove CUSTOMERID USERIDS

Remove a permission from a customer

USAGE
  $ pliancy-cli permissions:remove CUSTOMERID USERIDS

ARGUMENTS
  CUSTOMERID  the customer to apply permission to
  USERIDS     the user or users for permission removal. If multiple, separate by comma

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLES
  $ pliancy-cli permissions:remove ABC user1@abc.com
  $ pliancy-cli permissions:remove ABC user1@abc.com,user2@abc.com

See code: commands/permissions/remove.ts

pliancy-cli permissions:set CUSTOMERID USERIDS PERMISSIONLEVEL

Set a permission on a customer

USAGE
  $ pliancy-cli permissions:set CUSTOMERID USERIDS PERMISSIONLEVEL

ARGUMENTS
  CUSTOMERID       the customer to apply permission to
  USERIDS          the user or users for permission. If multiple, separate by comma
  PERMISSIONLEVEL  (FULL|USER|READ) the permission level the user gets

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -f, --force                  bypass confirmation (BE CAREFUL!)
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLES
  $ pliancy-cli permissions:set ABC user1@abc.com FULL
  $ pliancy-cli permissions:set ABC user1@abc.com,user2@abc.com FULL

See code: commands/permissions/set.ts

pliancy-cli server:get

Get the server commands are running against

USAGE
  $ pliancy-cli server:get

See code: commands/server/get.ts

pliancy-cli server:set SERVER

Set the API server that commands should run against

USAGE
  $ pliancy-cli server:set SERVER

ARGUMENTS
  SERVER  the server you wish to runs commands against. Supports `prod`, `dev`, and `local` aliases for commonly used
          options

EXAMPLES
  $ pliancy-cli servers:set prod
  $ pliancy-cli servers:set api.pliancy.com
  $ pliancy-cli servers:set dev
  $ pliancy-cli servers:set api-dev.pliancy.com
  $ pliancy-cli servers:set local
  $ pliancy-cli servers:set localhost:8080

See code: commands/server/set.ts

pliancy-cli users:activation USERID [SENDTOADDRESS]

send activation for a user

USAGE
  $ pliancy-cli users:activation USERID [SENDTOADDRESS]

ARGUMENTS
  USERID         the pliancy userId to find
  SENDTOADDRESS  optional address to send to (will send to primary email otherwise)

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -f, --force                  bypass confirmation (BE CAREFUL!)
  -h, --help                   show CLI help
  -t, --templateId=templateId  the template id from postmark
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLE
  $ pliancy-cli users:activation josh@pliancy.com
  { User JSON Object }

See code: commands/users/activation.ts

pliancy-cli users:add CUSTOMERID [USERID] [NAME]

create a user

USAGE
  $ pliancy-cli users:add CUSTOMERID [USERID] [NAME]

ARGUMENTS
  CUSTOMERID  the customerId to create the user in
  USERID      the userId of the user
  NAME        the full name of the user

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --from-csv=./example.csv     CSV file path to import users from
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLE
  $ pliancy-cli users:add LIV user@loremipsumventures.com "Cool Guy"
  { User JSON Object }

See code: commands/users/toggle.ts

pliancy-cli users:bulk-update-manager CUSTOMERID

bulk update user manager field from CSV file

USAGE
  $ pliancy-cli users:bulk-update-manager CUSTOMERID

ARGUMENTS
  CUSTOMERID  the customerId of the client

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

  --users-list=./users.csv     (required) a list of newline seperated users and their corresponding manager value to run
                               operation on

EXAMPLE
  $ pliancy-cli users:bulk-update-manager LIV --users-list="file.csv"

See code: commands/users/bulk-update-manager.ts

pliancy-cli users:get [USERID]

get all/one user(s)

USAGE
  $ pliancy-cli users:get [USERID]

ARGUMENTS
  USERID  the pliancy userId to find

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -K, --knowbe4                output in csv format customized for import into KnowBe4
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLE
  $ pliancy-cli users:get josh@pliancy.com
  { User JSON Object }

See code: commands/users/get.ts

pliancy-cli users:mfa:get USERID

get mfa status for a user

USAGE
  $ pliancy-cli users:mfa:get USERID

ARGUMENTS
  USERID  the pliancy userId to find

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLE
  $ pliancy-cli users:mfa:get josh@pliancy.com
  { User JSON Object }

See code: commands/users/mfa/get.ts

pliancy-cli users:mfa:get-bypasscodes USERID [VALIDFOR]

get mfa bypass codes for a user

USAGE
  $ pliancy-cli users:mfa:get-bypasscodes USERID [VALIDFOR]

ARGUMENTS
  USERID    the pliancy userId to get bypass code for
  VALIDFOR  [default: 900] How long in seconds code will last (defaults to 900 seconds [15 minutes])

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLE
  $ pliancy-cli users:mfa:get-bypasscodes josh@pliancy.com
  { User JSON Object }

See code: commands/users/mfa/get-bypasscodes.ts

pliancy-cli users:mfa:set USERID STATE

get mfa status for a user

USAGE
  $ pliancy-cli users:mfa:set USERID STATE

ARGUMENTS
  USERID  the pliancy userId to change MFA state of
  STATE   (ACTIVE|BYPASS) the MFA state to set

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLE
  $ pliancy-cli users:mfa:set josh@pliancy.com BYPASS
  { User JSON Object }

See code: commands/users/mfa/set.ts

pliancy-cli users:password USERID

sets a password for a user

USAGE
  $ pliancy-cli users:password USERID

ARGUMENTS
  USERID  the userId of the user

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  -t, --temp                   set a random temp password and require change on next login
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]

EXAMPLE
  $ pliancy-cli users:password user@loremipsumventures.com
  { User JSON Object }

See code: commands/users/password.ts

pliancy-cli users:set [USERID] [ATTRIBUTE] [VALUE]

update a user

USAGE
  $ pliancy-cli users:set [USERID] [ATTRIBUTE] [VALUE]

ARGUMENTS
  USERID     the userId of the user
  ATTRIBUTE  top level attribute to set
  VALUE      value for the attribute (arrays need to be comma seperated, see examples)

OPTIONS
  -A, --all                    show all columns in table view
  -C, --csv                    output in csv format
  -J, --json                   output in json format
  -Y, --yaml                   output in yaml format
  -h, --help                   show CLI help
  --filter=filter              filter on column (key=value)
  --table-output=table-output  output for table view. [csv, yaml, json]
  --users-list=./users.txt     a list of newline seperated users to run operation on

EXAMPLES
  $ pliancy-cli users:set user@loremipsumventures.com name "Cool Guy"

  $ pliancy-cli users:set user@loremipsumventures.com emails "ADD:RECOVERY:anotheremail@backuplocation.com"

  $ pliancy-cli users:set user@loremipsumventures.com apps "ADD:INTUNE:USER,DEL:DUMBAPP:USER"

  $ pliancy-cli users:set user@loremipsumventures.com phones "ADD:MOBILE:5551231234"

See code: commands/users/set.ts

pliancy-cli version:get

Get the Pliancy API version commands are running against

USAGE
  $ pliancy-cli version:get

See code: commands/version/get.ts

pliancy-cli version:set VERSION

the version of the Pliancy API to use

USAGE
  $ pliancy-cli version:set VERSION

ARGUMENTS
  VERSION  the version of the Pliancy API to use

EXAMPLES
  $ pliancy-cli version:set {1|2}

See code: commands/version/set.ts

Readme

Keywords

Package Sidebar

Install

npm i pliancy-cli

Repository

github.com/pliancy/pliancy-cli

Homepage

github.com/pliancy/pliancy-cli

Weekly Downloads

0

Version

3.0.5

License

MIT

Unpacked Size

628 kB

Total Files

112

Last publish

Collaborators

  • pliancy-bot
Try on RunKit
Report malware