---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "immich_album Resource - immich"
subcategory: ""
description: |-
  Manages an Immich album.
---

# immich_album (Resource)

Manages an Immich album.

## Example Usage

```terraform
resource "immich_album" "example" {
  name        = "Vacation 2024"
  description = "Photos from our summer vacation"
  order       = "desc"

  users = [
    {
      user_id = "some-user-id"
      role    = "Editor"
    }
  ]
}
```

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

### Required

- `name` (String) Display name of the album.

### Optional

- `album_thumbnail_asset_id` (String) ID of the asset used as the album's thumbnail.
- `asset_ids` (List of String) List of asset IDs to include in the album.
- `description` (String) Optional description of the album.
- `is_activity_enabled` (Boolean) Whether user activity (comments/likes) is enabled for this album.
- `order` (String) Sort order for assets in the album. Must be either `asc` or `desc`.
- `users` (Attributes List) List of users to share the album with. (see [below for nested schema](#nestedatt--users))

### Read-Only

- `id` (String) Unique identifier for the album.

<a id="nestedatt--users"></a>
### Nested Schema for `users`

Required:

- `role` (String) Role granted to the user. Must be either `Editor` or `Viewer`.
- `user_id` (String) Unique identifier of the user to share with.