drewmullenandMichael Li
b1936800b3
* remove unnecessary template * Update README.md Co-authored-by: Michael Li <michael.li@hashicorp.com> --------- Co-authored-by: Michael Li <michael.li@hashicorp.com>
64 lines
1.5 KiB
Markdown
64 lines
1.5 KiB
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "boundary_user Data Source - terraform-provider-boundary"
|
|
subcategory: ""
|
|
description: |-
|
|
The user data source allows you to find a Boundary user.
|
|
---
|
|
|
|
# boundary_user (Data Source)
|
|
|
|
The user data source allows you to find a Boundary user.
|
|
|
|
## Example Usage
|
|
|
|
```terraform
|
|
# Retrieve a user from the global scope
|
|
data "boundary_user" "global_scope_admin" {
|
|
name = "admin"
|
|
}
|
|
|
|
# User from a org scope
|
|
data "boundary_user" "org_user" {
|
|
name = "username"
|
|
scope_id = data.boundary_scope.org.id
|
|
}
|
|
|
|
data "boundary_scope" "org" {
|
|
name = "my-org"
|
|
scope_id = data.boundary_scope.org.id
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### Required
|
|
|
|
- `name` (String) The username to search for.
|
|
|
|
### Optional
|
|
|
|
- `scope_id` (String) The scope ID in which the resource is created. Defaults `global` if unset.
|
|
|
|
### Read-Only
|
|
|
|
- `account_ids` (Set of String) Account ID's to associate with this user resource.
|
|
- `authorized_actions` (List of String) A list of actions that the worker is entitled to perform.
|
|
- `description` (String) The user description.
|
|
- `id` (String) The ID of the user.
|
|
- `login_name` (String) Login name for user.
|
|
- `primary_account_id` (String) Primary account ID.
|
|
- `scope` (List of Object) (see [below for nested schema](#nestedatt--scope))
|
|
|
|
<a id="nestedatt--scope"></a>
|
|
### Nested Schema for `scope`
|
|
|
|
Read-Only:
|
|
|
|
- `description` (String)
|
|
- `id` (String)
|
|
- `name` (String)
|
|
- `parent_scope_id` (String)
|
|
- `type` (String)
|