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

64 lines
1.7 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_auth_method Resource - terraform-provider-boundary"
subcategory: ""
description: |-
The auth method resource allows you to configure a Boundary auth_method.
---
2021-05-05 10:02:53 -07:00
# boundary_auth_method (Resource)
2020-10-06 20:34:16 -04:00
The auth method resource allows you to configure a Boundary auth_method.
## 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"
}
resource "boundary_auth_method" "password_is_primary" {
scope_id = boundary_scope.org.id
type = "password"
is_primary_for_scope = true
}
2020-10-06 20:34:16 -04:00
```
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.
- `type` (String) The resource type.
2020-10-06 20:34:16 -04:00
### Optional
2022-05-13 18:10:43 -07:00
- `description` (String) The auth method description.
- `is_primary_for_scope` (Boolean) When true, makes this auth method the primary auth method for the scope in which it resides.
2022-05-13 18:10:43 -07:00
- `min_login_name_length` (Number, Deprecated) The minimum login name length.
- `min_password_length` (Number, Deprecated) The minimum password length.
- `name` (String) The auth method name. 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 account.
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:
The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
2020-10-07 12:04:11 -04:00
```shell
terraform import boundary_auth_method.foo <my-id>
```