Skip to content

Latest commit

 

History

History
293 lines (218 loc) · 10.9 KB

org.md

File metadata and controls

293 lines (218 loc) · 10.9 KB

apimetrics org

Manage organization settings.

apimetrics org accounts

List all users in organization.

USAGE
  $ apimetrics org accounts [--json] [--columns <value> | -x] [--filter <value>] [--no-header | [--csv |
    --no-truncate]] [--output csv|json|yaml |  | ] [--sort <value>] [-o <value>]

FLAGS
  -o, --org-id=<value>   ID of organization to read. Overrides apimetrics config org set.Can be found on the
                         Organization Settings web page.
  -x, --extended         show extra columns
      --columns=<value>  only show provided columns (comma-separated)
      --csv              output is csv format [alias: --output=csv]
      --filter=<value>   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=<option>  output in a more machine friendly format
                         <options: csv|json|yaml>
      --sort=<value>     property to sort by (prepend '-' for descending)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List all users in organization.

EXAMPLES
  $ apimetrics org accounts
  Name              Email             Roles                    Last login
  ───────────────── ───────────────── ──────────────────────── ────────────────────────
  [email protected] [email protected] DEFAULT                  2023-08-02T21:15:48.072Z
  Bob               [email protected]   DEFAULT, ADMIN, DEV_TEAM 2023-08-01T23:41:07.733Z 

  $ apimetrics org accounts --columns name,id
  Name              ID
  ───────────────── ──────────────────────────────
  [email protected] auth0|abcdefghijklmnopqrstuvwx
  Bob               auth0|zyxwvutsrqponmlkjihgfedc

See code: src/commands/org/accounts/index.ts

apimetrics org accounts edit

Edit an account.

USAGE
  $ apimetrics org accounts edit -u <value> [--json] [--add-role <value>] [-o <value>] [--remove-role <value>]

FLAGS
  -o, --org-id=<value>          ID of organization to modify. Overrides apimetrics config org set.
  -u, --user-id=<value>         (required) ID or email of user. ID can be found in the Accounts section of the
                                Organization Settings web page or by using the command `apimetrics org accounts
                                --columns name,id`.
      --add-role=<value>...     Add a role to the account.
      --remove-role=<value>...  Name of role to remove.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Edit an account.

EXAMPLES
  $ apimetrics org accounts edit -u auth0|abc123 --add-role ADMIN --remove-role DEV_TEAM

See code: src/commands/org/accounts/edit.ts

apimetrics org accounts remove

Remove an account from the organization.

USAGE
  $ apimetrics org accounts remove -u <value> [--json] [-o <value>]

FLAGS
  -o, --org-id=<value>   ID of organization to modify. Overrides apimetrics config org set.
  -u, --user-id=<value>  (required) ID or email of user to remove. ID can be found in the Accounts section of the
                         Organization Settings web page or by using the command `apimetrics org accounts --columns
                         name,id`.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Remove an account from the organization.

EXAMPLES
  $ apimetrics org accounts remove --user-id "auth0|abcdefghijklmnopqrstuvwx"

See code: src/commands/org/accounts/remove.ts

apimetrics org invites

List all current invites to the Organization.

USAGE
  $ apimetrics org invites [--json] [--columns <value> | -x] [--filter <value>] [--no-header | [--csv |
    --no-truncate]] [--output csv|json|yaml |  | ] [--sort <value>] [-o <value>]

FLAGS
  -o, --org-id=<value>   ID of organization to read. Overrides apimetrics config org set.Can be found on the
                         Organization Settings web page.
  -x, --extended         show extra columns
      --columns=<value>  only show provided columns (comma-separated)
      --csv              output is csv format [alias: --output=csv]
      --filter=<value>   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=<option>  output in a more machine friendly format
                         <options: csv|json|yaml>
      --sort=<value>     property to sort by (prepend '-' for descending)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List all current invites to the Organization.

EXAMPLES
  $ apimetrics org invites
  Email             Roles    Created
  ───────────────── ──────── ───────────────────────────
  [email protected]   ADMIN    2023-07-15T18:32:41.626327Z
  [email protected] DEV_TEAM 2023-07-15T18:34:27.044198Z

See code: src/commands/org/invites/index.ts

apimetrics org invites create

Create an invite to the Organization.

USAGE
  $ apimetrics org invites create --email <value> --role <value> [--json] [-o <value>]

FLAGS
  -o, --org-id=<value>   ID of organization to modify. Overrides apimetrics config org set.Can be found on the
                         Organization Settings web page.
      --email=<value>    (required) Email to send invite to.
      --role=<value>...  (required) Users role.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Create an invite to the Organization.

EXAMPLES
  $ apimetrics org invites create --email [email protected] --role ADMIN --role DEV_TEAM
  ag9zfmFwaW1ldHJpY3MtcWNyFwsSClRlc3RTZXR1cDIYgIDg9ajJsyoM

See code: src/commands/org/invites/create.ts

apimetrics org invites delete

Delete an invite to the Organization.

USAGE
  $ apimetrics org invites delete --invite-id <value> [--json] [-o <value>]

FLAGS
  -o, --org-id=<value>     ID of organization to modify. Overrides apimetrics config org set.Can be found on the
                           Organization Settings web page.
      --invite-id=<value>  (required) Invite to delete. Can be found in the Diff of the Audit Logs web page for when the
                           invite was created or by using the command `apimetrics org invites --columns email,roles,id`.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Delete an invite to the Organization.

EXAMPLES
  $ apimetrics org invites delete --invite-id ag9zfmFwaW1ldHJpY3MtcWNyFwsSClRlc3RTZXR1cDIYgIDg9ajJsyoM

See code: src/commands/org/invites/delete.ts

apimetrics org roles

List all roles within the Organization.

USAGE
  $ apimetrics org roles [--json] [--columns <value> | ] [--filter <value>] [--no-header | [--csv |
    --no-truncate]] [--output csv|json|yaml |  | ] [--sort <value>] [-o <value>]

FLAGS
  -o, --org-id=<value>   ID of organization to read. Overrides apimetrics config org set.Can be found on the
                         Organization Settings web page.
      --columns=<value>  only show provided columns (comma-separated)
      --csv              output is csv format [alias: --output=csv]
      --filter=<value>   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=<option>  output in a more machine friendly format
                         <options: csv|json|yaml>
      --sort=<value>     property to sort by (prepend '-' for descending)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List all roles within the Organization.

EXAMPLES
  $ apimetrics org roles
  Role   Description                     Created
  ────── ─────────────────────────────── ───────────────────────────
  ADMIN  Organization Administrator Role 2021-02-25T01:53:42.656838Z
  TEAM_A Development team A              2023-07-16T21:53:30.522729Z

See code: src/commands/org/roles/index.ts

apimetrics org roles create

Create a new role within the Organization.

USAGE
  $ apimetrics org roles create -d <value> -n <value> [--json] [-o <value>]

FLAGS
  -d, --description=<value>  (required) Role description.
  -n, --name=<value>         (required) Name of role.
  -o, --org-id=<value>       ID of organization to modify. Overrides apimetrics config org set.Can be found on the
                             Organization Settings web page.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Create a new role within the Organization.

EXAMPLES
  $ apimetrics org roles create --name TEAM_A --description "Development team A"
  TEAM_A

See code: src/commands/org/roles/create.ts

apimetrics org roles delete

Delete a role from the organization.

USAGE
  $ apimetrics org roles delete -r <value> [--json] [-o <value>]

FLAGS
  -o, --org-id=<value>  ID of organization to modify. Overrides apimetrics config org set.Can be found on the
                        Organization Settings web page.
  -r, --role=<value>    (required) ID of role to delete. This is the name of the role capitalized and with whitespace
                        replaced by underscores.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Delete a role from the organization.

EXAMPLES
  $ apimetrics org roles delete --role TEAM_A

See code: src/commands/org/roles/delete.ts