61 lines
1.4 KiB
Markdown
61 lines
1.4 KiB
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "boundary_auth_method Data Source - terraform-provider-boundary"
|
|
subcategory: ""
|
|
description: |-
|
|
The boundaryauthmethod data source allows you to find a Boundary auth method.
|
|
---
|
|
|
|
# boundary_auth_method (Data Source)
|
|
|
|
The boundary_auth_method data source allows you to find a Boundary auth method.
|
|
|
|
## Example Usage
|
|
|
|
```terraform
|
|
# Retrieve an auth method from the global scope
|
|
data "boundary_auth_method" "auth_method" {
|
|
name = "password_auth_method"
|
|
}
|
|
|
|
# Auth method from a org scope
|
|
data "boundary_scope" "org" {
|
|
name = "my-org"
|
|
scope_id = "global"
|
|
}
|
|
|
|
data "boundary_auth_method" "auth_method" {
|
|
name = "password_auth_method"
|
|
scope_id = data.boundary_scope.org.id
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### Required
|
|
|
|
- `name` (String) The name of the auth method to retrieve.
|
|
|
|
### Optional
|
|
|
|
- `scope_id` (String) The scope ID in which the resource is created. Defaults `global` if unset.
|
|
|
|
### Read-Only
|
|
|
|
- `description` (String) The description of the retrieved auth method.
|
|
- `id` (String) The ID of the retrieved auth method.
|
|
- `scope` (List of Object) (see [below for nested schema](#nestedatt--scope))
|
|
- `type` (String) The type of the auth method
|
|
|
|
<a id="nestedatt--scope"></a>
|
|
### Nested Schema for `scope`
|
|
|
|
Read-Only:
|
|
|
|
- `description` (String)
|
|
- `id` (String)
|
|
- `name` (String)
|
|
- `parent_scope_id` (String)
|
|
- `type` (String)
|