43 lines
1.2 KiB
Markdown
43 lines
1.2 KiB
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "immich_user Resource - terraform-provider-immich"
|
|
subcategory: ""
|
|
description: |-
|
|
Manages an Immich user account.
|
|
---
|
|
|
|
# immich_user (Resource)
|
|
|
|
Manages an Immich user account.
|
|
|
|
## Example Usage
|
|
|
|
```terraform
|
|
resource "immich_user" "example" {
|
|
email = "user@example.com"
|
|
name = "Example User"
|
|
password = "securepassword123"
|
|
is_admin = false
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### Required
|
|
|
|
- `email` (String) Email address of the user. This is used for login.
|
|
- `name` (String) Full name of the user.
|
|
- `password` (String, Sensitive) Initial password for the user. Only used during creation or when forced by `should_change_password`.
|
|
|
|
### Optional
|
|
|
|
- `is_admin` (Boolean) Whether the user has administrative privileges.
|
|
- `quota_size_in_bytes` (Number) Maximum storage quota for the user in bytes. Set to 0 or null for unlimited.
|
|
- `should_change_password` (Boolean) Force the user to change their password on next login.
|
|
- `storage_label` (String) Label used for the user's storage path.
|
|
|
|
### Read-Only
|
|
|
|
- `id` (String) Unique identifier for the user.
|