48 lines
1.1 KiB
Markdown
48 lines
1.1 KiB
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "boundary_account Data Source - terraform-provider-boundary"
|
|
subcategory: ""
|
|
description: |-
|
|
The boundary_account data source allows you to find a Boundary account.
|
|
---
|
|
|
|
# boundary_account (Data Source)
|
|
|
|
The boundary_account data source allows you to find a Boundary account.
|
|
|
|
## Example Usage
|
|
|
|
```terraform
|
|
# Retrieve the ID of a Boundary account
|
|
data "boundary_account" "admin" {
|
|
name = "admin"
|
|
auth_method_id = "ampw_1234567890"
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### Required
|
|
|
|
- `auth_method_id` (String) The auth method ID that will be queried for the account.
|
|
- `name` (String) The name of the account to retrieve.
|
|
|
|
### Read-Only
|
|
|
|
- `description` (String) The description of the retrieved account.
|
|
- `id` (String) The ID of the retrieved account.
|
|
- `scope` (List of Object) (see [below for nested schema](#nestedatt--scope))
|
|
- `type` (String) The type of the account
|
|
|
|
<a id="nestedatt--scope"></a>
|
|
### Nested Schema for `scope`
|
|
|
|
Read-Only:
|
|
|
|
- `description` (String)
|
|
- `id` (String)
|
|
- `name` (String)
|
|
- `parent_scope_id` (String)
|
|
- `type` (String)
|