OmniArc docs Menu

CLI reference

omniarc key

Generated from the code · as of CLI 0.6.0

Your organization's API keys: list, create and revoke them.

omniarc key [OPTIONS] <COMMAND>

Options:

  • --json: Print machine-readable JSON instead of a table.

# omniarc key list

Every API key this organization has minted. It never shows a key itself: only create prints one, once.

omniarc key list [OPTIONS]

Options:

  • --json: Print machine-readable JSON instead of a table.

# omniarc key create

Mint a new API key. The plaintext is printed exactly once, here, and cannot be retrieved again afterwards.

omniarc key create [OPTIONS] <NAME>

Arguments:

  • <NAME>: A name for the key, to tell it apart in key list.

Options:

  • --role <ROLE>: The key's role. Defaults to member — never your own — and can never exceed it; the orchestrator refuses a request that tries.
  • --json: Print machine-readable JSON instead of a table.

# omniarc key revoke

Revoke an API key by id. Takes effect on its next use.

omniarc key revoke [OPTIONS] <ID>

Arguments:

  • <ID>: The key's id, as key list shows it.

Options:

  • --json: Print machine-readable JSON instead of a table.