onyx_api_key (Resource)

An Onyx API key. The key material is returned by the API exactly once at creation and is kept in Terraform state (api_key, sensitive) from then on; it can never be re-read, so after terraform import the attribute stays null. Note the chicken-and-egg: the key the provider itself authenticates with must be created out-of-band (admin UI or curl).

Example Usage

# A key for an internal integration. The key material is in
# onyx_api_key.ingest.api_key (sensitive, state-only).
resource "onyx_api_key" "ingest" {
  name = "ingest-pipeline"
  role = "basic"
}

Schema

Optional

• name (String) Display name for the key.
• role (String) Role of the service account backing the key: basic, admin, curator, global_curator, or limited.

Read-Only

• api_key (String, Sensitive) The key material (on_...). Only available when the key was created by Terraform; null after import.
• api_key_display (String) Redacted form of the key, safe for display.
• id (String) Numeric API key id.
• user_id (String) UUID of the synthetic service-account user backing the key.

Import

Import is supported using the following syntax:

The terraform import command can be used, for example:

#!/bin/sh
# Import by numeric API key id. The key material can never be re-read,
# so the api_key attribute stays null after import.
terraform import onyx_api_key.ingest 5