37 lines
948 B
Markdown
37 lines
948 B
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "immich_api_key Resource - immich"
|
|
subcategory: ""
|
|
description: |-
|
|
Manages an Immich personal API key. Note that the secret is only available upon creation.
|
|
---
|
|
|
|
# immich_api_key (Resource)
|
|
|
|
Manages an Immich personal API key. Note that the secret is only available upon creation.
|
|
|
|
## Example Usage
|
|
|
|
```terraform
|
|
resource "immich_api_key" "example" {
|
|
name = "Example API Key"
|
|
permissions = ["asset.read", "asset.upload"]
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### Required
|
|
|
|
- `permissions` (List of String) List of permissions granted to this API key (e.g. `asset.read`, `asset.upload`).
|
|
|
|
### Optional
|
|
|
|
- `name` (String) Display name for the API key.
|
|
|
|
### Read-Only
|
|
|
|
- `id` (String) Unique identifier for the API key.
|
|
- `secret` (String, Sensitive) The generated API key secret. This value is only returned when the key is created.
|