---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "immich_shared_link Resource - immich"
subcategory: ""
description: |-
  Manages an Immich shared link for albums or individual assets.
---

# immich_shared_link (Resource)

Manages an Immich shared link for albums or individual assets.

## Example Usage

```terraform
resource "immich_shared_link" "example" {
  type           = "ALBUM"
  album_id       = "some-album-id"
  description    = "My shared album"
  allow_download = true
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `type` (String) Type of the shared link. Must be either `ALBUM` or `INDIVIDUAL`.

### Optional

- `album_id` (String) ID of the album to share (required if type is `ALBUM`).
- `allow_download` (Boolean) Whether to allow users with the link to download assets.
- `allow_upload` (Boolean) Whether to allow users with the link to upload assets.
- `asset_ids` (List of String) List of asset IDs to share (required if type is `INDIVIDUAL`).
- `description` (String) Optional description for the shared link.
- `expires_at` (String) ISO 8601 formatted timestamp when the link expires.
- `password` (String, Sensitive) Optional password protection for the link.
- `show_metadata` (Boolean) Whether to show asset metadata to users with the link.
- `slug` (String) Custom URL slug for the shared link.

### Read-Only

- `id` (String) Unique identifier for the shared link.
- `key` (String) The encryption key for the shared link.