Files
terraform-provider-threshold/docs/resources/user.md
T

67 lines
1.6 KiB
Markdown
Raw Normal View History

2020-10-06 20:34:16 -04:00
---
2021-01-14 14:07:36 -08:00
# generated by https://github.com/hashicorp/terraform-plugin-docs
2020-10-06 20:34:16 -04:00
page_title: "boundary_user Resource - terraform-provider-boundary"
subcategory: ""
description: |-
The user resource allows you to configure a Boundary user.
---
2021-05-05 10:02:53 -07:00
# boundary_user (Resource)
2020-10-06 20:34:16 -04:00
The user resource allows you to configure a Boundary user.
## Example Usage
```terraform
resource "boundary_scope" "org" {
2020-10-13 23:12:03 -04:00
name = "organization_one"
description = "My first scope!"
scope_id = "global"
auto_create_admin_role = true
auto_create_default_role = true
2020-10-06 20:34:16 -04:00
}
resource "boundary_auth_method" "password" {
scope_id = boundary_scope.org.id
type = "password"
}
2022-05-13 18:10:43 -07:00
resource "boundary_account_password" "jeff" {
2020-10-06 20:34:16 -04:00
auth_method_id = boundary_auth_method.password.id
type = "password"
login_name = "jeff"
password = "$uper$ecure"
}
resource "boundary_user" "jeff" {
name = "jeff"
description = "Jeff's user resource"
2022-05-13 18:10:43 -07:00
account_ids = [boundary_account_password.jeff.id]
2020-10-06 20:34:16 -04:00
scope_id = boundary_scope.org.id
}
```
2021-01-14 14:07:36 -08:00
<!-- schema generated by tfplugindocs -->
2020-10-06 20:34:16 -04:00
## Schema
### Required
2022-05-13 18:10:43 -07:00
- `scope_id` (String) The scope ID in which the resource is created. Defaults to the provider's `default_scope` if unset.
2020-10-06 20:34:16 -04:00
### Optional
2022-05-13 18:10:43 -07:00
- `account_ids` (Set of String) Account ID's to associate with this user resource.
- `description` (String) The user description.
- `name` (String) The username. Defaults to the resource name.
2020-10-06 20:34:16 -04:00
2021-05-05 10:02:53 -07:00
### Read-Only
2022-05-13 18:10:43 -07:00
- `id` (String) The ID of the user.
2020-10-07 12:04:11 -04:00
## Import
2020-10-06 20:34:16 -04:00
2020-10-07 12:04:11 -04:00
Import is supported using the following syntax:
```shell
terraform import boundary_user.foo <my-id>
```