Flowcore CLI Plugin - Auth Management

A Flowcore CLI plugin for managing authentication in the Flowcore Platform

• Usage
• Commands

Usage

$ npm install -g @flowcore/cli-plugin-auth-management
$ auth COMMAND
running command...
$ auth (--version)
@flowcore/cli-plugin-auth-management/1.8.0 linux-x64 node-v20.20.2
$ auth --help [COMMAND]
USAGE
  $ auth COMMAND
...

Commands

• auth auth delete key API_KEY_NAME
• auth auth delete pat PAT
• auth auth delete secret SECRET_KEY
• auth auth list key
• auth auth list pat
• auth auth list secret
• auth auth new key NAME
• auth auth new pat NAME
• auth auth new secret NAME

auth auth delete key API_KEY_NAME

Delete an API key

USAGE
  $ auth auth delete key API_KEY_NAME -t <value> [--profile <value>]

ARGUMENTS
  API_KEY_NAME  Name of the API key to delete

FLAGS
  -t, --tenant=<value>   (required) tenant where the API key should be deleted
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  Delete an API key

EXAMPLES
  $ auth auth delete key --tenant=tenant-id <api-key-name>

See code: src/commands/auth/delete/key.ts

auth auth delete pat PAT

Delete a Personal Access Token (PAT)

USAGE
  $ auth auth delete pat PAT [--profile <value>] [-j]

ARGUMENTS
  PAT  PAT id to delete

FLAGS
  -j, --json             output the PAT in JSON format
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  Delete a Personal Access Token (PAT)

EXAMPLES
  $ auth auth delete pat <pat-id>

See code: src/commands/auth/delete/pat.ts

auth auth delete secret SECRET_KEY

Delete an organization secret

USAGE
  $ auth auth delete secret SECRET_KEY -t <value> [--profile <value>]

ARGUMENTS
  SECRET_KEY  Key of the secret to delete

FLAGS
  -t, --tenant=<value>   (required) tenant where the secret should be deleted
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  Delete an organization secret

EXAMPLES
  $ auth auth delete secret --tenant=tenant-id <secret-key>

See code: src/commands/auth/delete/secret.ts

auth auth list key

List all API keys

USAGE
  $ auth auth list key -t <value> [--profile <value>] [-j]

FLAGS
  -j, --json             output the API key in JSON format
  -t, --tenant=<value>   (required) tenant where the API keys should be listed
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  List all API keys

EXAMPLES
  $ auth auth list key --tenant=tenant-id

See code: src/commands/auth/list/key.ts

auth auth list pat

List all Personal Access Tokens (PATs)

USAGE
  $ auth auth list pat [--profile <value>] [-j]

FLAGS
  -j, --json             output the PATs in JSON format
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  List all Personal Access Tokens (PATs)

EXAMPLES
  $ auth auth list pat

See code: src/commands/auth/list/pat.ts

auth auth list secret

List all organization secrets

USAGE
  $ auth auth list secret -t <value> [--profile <value>] [-j]

FLAGS
  -j, --json             output the secrets in JSON format
  -t, --tenant=<value>   (required) tenant where the secrets should be listed
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  List all organization secrets

EXAMPLES
  $ auth auth list secret --tenant=tenant-id

See code: src/commands/auth/list/secret.ts

auth auth new key NAME

Create a new API key

USAGE
  $ auth auth new key NAME -t <value> [--profile <value>] [-j]

ARGUMENTS
  NAME  name of the API key

FLAGS
  -j, --json             output the API key in JSON format
  -t, --tenant=<value>   (required) tenant where the API key should be created
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  Create a new API key

EXAMPLES
  $ auth auth new key --tenant=tenant-id --name=key-name

See code: src/commands/auth/new/key.ts

auth auth new pat NAME

Create a new PAT (Personal Access Token)

USAGE
  $ auth auth new pat NAME [--profile <value>] [-j]

ARGUMENTS
  NAME  PAT name

FLAGS
  -j, --json             output the API key in JSON format
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  Create a new PAT (Personal Access Token)

EXAMPLES
  $ auth auth new pat <pat-name>

See code: src/commands/auth/new/pat.ts

auth auth new secret NAME

Create a new secret for the tenant

USAGE
  $ auth auth new secret NAME -t <value> [--profile <value>] [--from-file <value>] [--from-literal <value>]

ARGUMENTS
  NAME  name of the secret

FLAGS
  -t, --tenant=<value>        (required) tenant where the secret should be created
      --from-file=<value>     read value from a file
      --from-literal=<value>  use literal value instead of reading from stdin
      --profile=<value>       Specify the configuration profile to use

DESCRIPTION
  Create a new secret for the tenant

EXAMPLES
  $ auth auth new secret --tenant=tenant-id --from-literal=value

See code: src/commands/auth/new/secret.ts