Orgs Commands

orgs

View and manage orgs.

Usage:

orgs [OPTIONS] COMMAND [ARGS]...

Options:

  --log-stderr      Enable logging to stderr.
  --log-file TEXT   Specify file path to write log output to.
  --log-level TEXT  Set level for Incydr client logging.
  --help            Show this message and exit.

orgs activate

Activate the given org.

Usage:

orgs activate [OPTIONS] ORG_GUID

Options:

  --log-stderr      Enable logging to stderr.
  --log-file TEXT   Specify file path to write log output to.
  --log-level TEXT  Set level for Incydr client logging.
  --help            Show this message and exit.

orgs create

Create a new org.

Usage:

orgs create [OPTIONS] NAME

Options:

  --external-reference TEXT  The external reference string for the org.
                             Defaults to None.
  --notes TEXT               The notes string for the org. Defaults to None.
  --parent-org-guid TEXT     The org guid for the created org's parent.
                             Defaults to your tenant's parent org.
  -f, --format SINGLEFORMAT  Format to print result. One of 'rich', 'json-
                             pretty', or 'json-lines'. If environment has
                             INCYDR_USE_RICH=false set, defaults to 'json-
                             lines', else defaults to 'rich'.
  --columns TEXT             Comma-delimited string of column names. Nested
                             values should be specified in dot-notation.
                             Limits output to contain only the specified
                             columns in CSV or Table format.  Ignored for JSON
                             output formats.
  --log-stderr               Enable logging to stderr.
  --log-file TEXT            Specify file path to write log output to.
  --log-level TEXT           Set level for Incydr client logging.
  --help                     Show this message and exit.

orgs deactivate

Deactivate the given org.

Usage:

orgs deactivate [OPTIONS] ORG_GUID

Options:

  --log-stderr      Enable logging to stderr.
  --log-file TEXT   Specify file path to write log output to.
  --log-level TEXT  Set level for Incydr client logging.
  --help            Show this message and exit.

orgs list

List orgs.

Usage:

orgs list [OPTIONS]

Options:

  --active / --inactive     Filter by active or inactive orgs. Defaults to
                            returning both when when neither option is passed.
  -f, --format TABLEFORMAT  Format to print result. One of 'table', 'json-
                            pretty', 'json-lines', or 'csv. If environment has
                            INCYDR_USE_RICH=false set, defaults to 'json-
                            lines', else defaults to 'table'.
  --columns TEXT            Comma-delimited string of column names. Nested
                            values should be specified in dot-notation. Limits
                            output to contain only the specified columns in
                            CSV or Table format.  Ignored for JSON output
                            formats.
  --log-stderr              Enable logging to stderr.
  --log-file TEXT           Specify file path to write log output to.
  --log-level TEXT          Set level for Incydr client logging.
  --help                    Show this message and exit.

orgs show

View details of an org.

Usage:

orgs show [OPTIONS] ORG_GUID

Options:

  -f, --format SINGLEFORMAT  Format to print result. One of 'rich', 'json-
                             pretty', or 'json-lines'. If environment has
                             INCYDR_USE_RICH=false set, defaults to 'json-
                             lines', else defaults to 'rich'.
  --columns TEXT             Comma-delimited string of column names. Nested
                             values should be specified in dot-notation.
                             Limits output to contain only the specified
                             columns in CSV or Table format.  Ignored for JSON
                             output formats.
  --log-stderr               Enable logging to stderr.
  --log-file TEXT            Specify file path to write log output to.
  --log-level TEXT           Set level for Incydr client logging.
  --help                     Show this message and exit.

orgs update

Update an org.

Usage:

orgs update [OPTIONS] ORG_GUID

Options:

  --name TEXT                The name of the org being updated. Required.
                             [required]
  --external-reference TEXT  The external reference string for the org.
                             Defaults to None.
  --notes TEXT               The notes string for the org. Defaults to None.
  -f, --format SINGLEFORMAT  Format to print result. One of 'rich', 'json-
                             pretty', or 'json-lines'. If environment has
                             INCYDR_USE_RICH=false set, defaults to 'json-
                             lines', else defaults to 'rich'.
  --columns TEXT             Comma-delimited string of column names. Nested
                             values should be specified in dot-notation.
                             Limits output to contain only the specified
                             columns in CSV or Table format.  Ignored for JSON
                             output formats.
  --log-stderr               Enable logging to stderr.
  --log-file TEXT            Specify file path to write log output to.
  --log-level TEXT           Set level for Incydr client logging.
  --help                     Show this message and exit.