Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

pliancy-cli

2.3.0 • 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.3.0 linux-x64 node-v13.14.0
$ 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
  -C, --csv   output in csv format
  -J, --json  output in json format
  -Y, --yaml  output in yaml format
  -h, --help  show CLI help

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

See code: src/commands/appcatalog/add.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
  -C, --csv   output in csv format
  -J, --json  output in json format
  -Y, --yaml  output in yaml format
  -h, --help  show CLI help

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

See code: src/commands/appcatalog/get.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
  -C, --csv   output in csv format
  -J, --json  output in json format
  -Y, --yaml  output in yaml format
  -h, --help  show CLI help

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

See code: src/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
  -C, --csv   output in csv format
  -J, --json  output in json format
  -Y, --yaml  output in yaml format
  -h, --help  show CLI help

See code: src/commands/auth/get.ts

pliancy-cli auth:get-roles

Inspects current roles you have locally

USAGE
  $ pliancy-cli auth:get-roles

OPTIONS
  -C, --csv   output in csv format
  -J, --json  output in json format
  -Y, --yaml  output in yaml format
  -h, --help  show CLI help

See code: src/commands/auth/get-roles.ts

pliancy-cli auth:refresh-roles

Refresh the locally cached set of roles you have access to

USAGE
  $ pliancy-cli auth:refresh-roles

OPTIONS
  -C, --csv   output in csv format
  -J, --json  output in json format
  -Y, --yaml  output in yaml format
  -h, --help  show CLI help

See code: src/commands/auth/refresh-roles.ts

pliancy-cli auth:set TYPE

Authenticate with the Pliancy API

USAGE
  $ pliancy-cli auth:set TYPE

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

OPTIONS
  -C, --csv   output in csv format
  -J, --json  output in json format
  -Y, --yaml  output in yaml format
  -h, --help  show CLI help

See code: src/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
  -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

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

See code: src/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
  -C, --csv   output in csv format
  -J, --json  output in json format
  -Y, --yaml  output in yaml format
  -h, --help  show CLI help

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

See code: src/commands/customers/add.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
  -C, --csv   output in csv format
  -J, --json  output in json format
  -Y, --yaml  output in yaml format
  -h, --help  show CLI help

EXAMPLE
  $ pliancy-cli customers:branding:get LIV

See code: src/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
  -C, --csv   output in csv format
  -J, --json  output in json format
  -Y, --yaml  output in yaml format
  -h, --help  show CLI help

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: src/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
  -C, --csv   output in csv format
  -J, --json  output in json format
  -Y, --yaml  output in yaml format
  -h, --help  show CLI help

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

See code: src/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
  -C, --csv   output in csv format
  -J, --json  output in json format
  -Y, --yaml  output in yaml format
  -h, --help  show CLI help

EXAMPLE
  $ pliancy-cli customers:remove LIV

See code: src/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
  -C, --csv                 output in csv format
  -J, --json                output in json format
  -Y, --yaml                output in yaml format
  -h, --help                show CLI help
  --from-csv=./example.csv  CSV file path to import users from

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

See code: src/commands/customers/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
  -C, --csv                  output in csv format
  -J, --json                 output in json format
  -Y, --yaml                 output in yaml format
  -a, --ad=ad                csv file for active directory users
  -e, --egnyte=egnyte        csv file for egnyte users
  -g, --gsuite=gsuite        csv file for g suite users
  -h, --help                 show CLI help
  -o, --office365=office365  csv file for office 365 users
  -z, --zoom=zoom            csv file for zoom users

EXAMPLE
  $ pliancy-cli eng:migrations:check-users

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

pliancy-cli eng:okta:audit-mfa [CUSTOMERID]

Audits apps in okta for MFA

USAGE
  $ pliancy-cli eng:okta:audit-mfa [CUSTOMERID]

ARGUMENTS
  CUSTOMERID  the pliancy customerId to find

OPTIONS
  -C, --csv   output in csv format
  -J, --json  output in json format
  -Y, --yaml  output in yaml format
  -h, --help  show CLI help

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

See code: src/commands/eng/okta/audit-mfa.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
  -C, --csv   output in csv format
  -J, --json  output in json format
  -Y, --yaml  output in yaml format
  -h, --help  show CLI help

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

See code: src/commands/permissions/get.ts

pliancy-cli permissions:remove CUSTOMERID USERID

Remove a permission from a customer

USAGE
  $ pliancy-cli permissions:remove CUSTOMERID USERID

ARGUMENTS
  CUSTOMERID  the customer to apply permission to
  USERID      the user to get the permission

OPTIONS
  -C, --csv   output in csv format
  -J, --json  output in json format
  -Y, --yaml  output in yaml format
  -h, --help  show CLI help

EXAMPLE
  $ pliancy-cli permissions:remove ABC user@abc.com
  { User JSON Object }

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

pliancy-cli permissions:set CUSTOMERID USERID PERMISSIONLEVEL

Set a permission on a customer

USAGE
  $ pliancy-cli permissions:set CUSTOMERID USERID PERMISSIONLEVEL

ARGUMENTS
  CUSTOMERID       the customer to apply permission to
  USERID           the user to get the permission
  PERMISSIONLEVEL  (FULL|USER|READ) the permission level the user gets

OPTIONS
  -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

EXAMPLE
  $ pliancy-cli permissions:set ABC josh@pliancy.com
  { User JSON Object }

See code: src/commands/permissions/set.ts

pliancy-cli server:get

Get the server commands are running against

USAGE
  $ pliancy-cli server:get

See code: src/commands/server/get.ts

pliancy-cli server:set SERVER

Set the server commands should run against

USAGE
  $ pliancy-cli server:set SERVER

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

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

See code: src/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
  -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

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

See code: src/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
  -C, --csv                 output in csv format
  -J, --json                output in json format
  -Y, --yaml                output in yaml format
  -h, --help                show CLI help
  --from-csv=./example.csv  CSV file path to import users from

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

See code: src/commands/users/add.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
  -C, --csv   output in csv format
  -J, --json  output in json format
  -Y, --yaml  output in yaml format
  -h, --help  show CLI help

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

See code: src/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
  -C, --csv   output in csv format
  -J, --json  output in json format
  -Y, --yaml  output in yaml format
  -h, --help  show CLI help

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

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

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

get mfa status 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

OPTIONS
  -C, --csv   output in csv format
  -J, --json  output in json format
  -Y, --yaml  output in yaml format
  -h, --help  show CLI help

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

See code: src/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
  -C, --csv   output in csv format
  -J, --json  output in json format
  -Y, --yaml  output in yaml format
  -h, --help  show CLI help

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

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

pliancy-cli users:password USERID

set a password for a user

USAGE
  $ pliancy-cli users:password USERID

ARGUMENTS
  USERID  the userId of the user

OPTIONS
  -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

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

See code: src/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
  -C, --csv                 output in csv format
  -J, --json                output in json format
  -Y, --yaml                output in yaml format
  -h, --help                show CLI help
  --from-csv=./example.csv  CSV file path to import users from

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: src/commands/users/set.ts

Keywords

Install

npm i [email protected]

Version

2.3.0

License

MIT

Unpacked Size

276 kB

Total Files

52

Last publish

Collaborators

  • avatar