Roles
List Roles
List all roles within the Organization.
USAGE
$ apimetrics org roles [--json] [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ] [-o <value>]
FLAGS
-o, --org-id=<value> ID of organization to read. Overrides apimetrics config org set.
-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 roles in 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
Create Role
Create a new role within the Organization.
USAGE
$ apimetrics org roles create -n <value> -d <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.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Create a role in the organization.
EXAMPLES
$ apimetrics org roles create --name TEAM_A --description "Development team A"
TEAM_A
Delete Role
Delete a role within the Organization. The Role ID will be the Name of the Role.
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.
-r, --role=<value> (required) ID of role to delete.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Delete a role from the organization.
EXAMPLES
$ apimetrics org roles delete --role TEAM_A
Updated 9 days ago