|
| 1 | +--- |
| 2 | +# generated by https://github.com/hashicorp/terraform-plugin-docs |
| 3 | +page_title: "meshstack_workspace_user_binding Resource - terraform-provider-meshstack" |
| 4 | +subcategory: "" |
| 5 | +description: |- |
| 6 | + Workspace user binding assigns a user with a specific role to a workspace. |
| 7 | +--- |
| 8 | + |
| 9 | +# meshstack_workspace_user_binding (Resource) |
| 10 | + |
| 11 | +Workspace user binding assigns a user with a specific role to a workspace. |
| 12 | + |
| 13 | +## Example Usage |
| 14 | + |
| 15 | +```terraform |
| 16 | +resource "meshstack_workspace_user_binding" "example" { |
| 17 | + metadata = { |
| 18 | + name = "this-is-an-example" |
| 19 | + } |
| 20 | +
|
| 21 | + role_ref = { |
| 22 | + name = "Workspace Member" |
| 23 | + } |
| 24 | +
|
| 25 | + target_ref = { |
| 26 | + name = "my-workspace" |
| 27 | + } |
| 28 | +
|
| 29 | + subject = { |
| 30 | + |
| 31 | + } |
| 32 | +} |
| 33 | +``` |
| 34 | + |
| 35 | +<!-- schema generated by tfplugindocs --> |
| 36 | +## Schema |
| 37 | + |
| 38 | +### Required |
| 39 | + |
| 40 | +- `metadata` (Attributes) Workspace user binding metadata. (see [below for nested schema](#nestedatt--metadata)) |
| 41 | +- `role_ref` (Attributes) Selects the role to use for this workspace binding. (see [below for nested schema](#nestedatt--role_ref)) |
| 42 | +- `subject` (Attributes) Selects the user for this binding. (see [below for nested schema](#nestedatt--subject)) |
| 43 | +- `target_ref` (Attributes) Selects the workspace to which this binding applies. (see [below for nested schema](#nestedatt--target_ref)) |
| 44 | + |
| 45 | +### Read-Only |
| 46 | + |
| 47 | +- `api_version` (String) Workspace user binding datatype version |
| 48 | +- `kind` (String) meshObject type, always `meshWorkspaceUserBinding`. |
| 49 | + |
| 50 | +<a id="nestedatt--metadata"></a> |
| 51 | +### Nested Schema for `metadata` |
| 52 | + |
| 53 | +Required: |
| 54 | + |
| 55 | +- `name` (String) The name identifies the binding and must be unique across the meshStack. |
| 56 | + |
| 57 | + |
| 58 | +<a id="nestedatt--role_ref"></a> |
| 59 | +### Nested Schema for `role_ref` |
| 60 | + |
| 61 | +Required: |
| 62 | + |
| 63 | +- `name` (String) |
| 64 | + |
| 65 | + |
| 66 | +<a id="nestedatt--subject"></a> |
| 67 | +### Nested Schema for `subject` |
| 68 | + |
| 69 | +Required: |
| 70 | + |
| 71 | +- `name` (String) Username. |
| 72 | + |
| 73 | + |
| 74 | +<a id="nestedatt--target_ref"></a> |
| 75 | +### Nested Schema for `target_ref` |
| 76 | + |
| 77 | +Required: |
| 78 | + |
| 79 | +- `name` (String) Workspace identifier. |
| 80 | + |
| 81 | +## Import |
| 82 | + |
| 83 | +Import is supported using the following syntax: |
| 84 | + |
| 85 | +```shell |
| 86 | +# import via workspace binding name |
| 87 | +terraform import 'meshstack_workspace_user_binding.example' 'my-binding-name' |
| 88 | +``` |
0 commit comments