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

variable "ingest_group_id" {
  type        = number
  description = "Id of an existing Onyx user group; ids are assigned per deployment."
}

# 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"
  group_ids = [var.ingest_group_id]
}

Schema

Optional

• name (String) Display name for the key.
• group_ids (Set of Number) Ids of the user groups the backing service account belongs to. The key resolves the union of those groups' permissions. Omit for a key with no group permissions. This replaces the whole group set on every apply.

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