-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
114 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
--- | ||
page_title: "codefresh_account_user_association Resource - terraform-provider-codefresh" | ||
subcategory: "" | ||
description: |- | ||
Associates a user with the account which the provider is authenticated against. If the user is not present in the system, an invitation will be sent to the specified email address. | ||
--- | ||
|
||
# codefresh_account_user_association (Resource) | ||
|
||
Associates a user with the account which the provider is authenticated against. If the user is not present in the system, an invitation will be sent to the specified email address. | ||
|
||
See the [documentation](https://codefresh.io/docs/docs/administration/account-user-management/add-users/#users-in-codefresh). | ||
|
||
## Example usage | ||
|
||
```hcl | ||
locals { | ||
users = { | ||
ed = { | ||
email = "[email protected]", | ||
admin = true, | ||
} | ||
edd = { | ||
email = "[email protected]", | ||
admin = true, | ||
} | ||
eddy = { | ||
email = "[email protected]", | ||
admin = false, | ||
} | ||
} | ||
} | ||
resource "codefresh_account_user_association" "users" { | ||
for_each = local.users, | ||
email = each.value.email, | ||
admin = each.value.admin, | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `email` (String) The email of the user to associate with the specified account. | ||
If the user is not present in the system, an invitation will be sent to this email. | ||
This field can only be changed when 'status' is 'pending'. | ||
|
||
### Optional | ||
|
||
- `admin` (Boolean) Whether to make this user an account admin. | ||
|
||
### Read-Only | ||
|
||
- `id` (String) The ID of this resource. | ||
- `status` (String) The status of the association. | ||
|
||
## Import | ||
|
||
An existing account user association can be imported via the user ID: | ||
|
||
```sh | ||
terraform import codefresh_account_user_association.test_user xxxxxxxxxxxxxxxxxxx | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
--- | ||
page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}" | ||
subcategory: "" | ||
description: |- | ||
{{ .Description | plainmarkdown | trimspace | prefixlines " " }} | ||
--- | ||
|
||
# {{.Name}} ({{.Type}}) | ||
|
||
{{ .Description | trimspace }} | ||
|
||
See the [documentation](https://codefresh.io/docs/docs/administration/account-user-management/add-users/#users-in-codefresh). | ||
|
||
## Example usage | ||
|
||
```hcl | ||
locals { | ||
users = { | ||
ed = { | ||
email = "[email protected]", | ||
admin = true, | ||
} | ||
edd = { | ||
email = "[email protected]", | ||
admin = true, | ||
} | ||
eddy = { | ||
email = "[email protected]", | ||
admin = false, | ||
} | ||
} | ||
} | ||
|
||
resource "codefresh_account_user_association" "users" { | ||
for_each = local.users, | ||
email = each.value.email, | ||
admin = each.value.admin, | ||
} | ||
``` | ||
|
||
{{ .SchemaMarkdown | trimspace }} | ||
|
||
## Import | ||
|
||
An existing account user association can be imported via the user ID: | ||
|
||
```sh | ||
terraform import codefresh_account_user_association.test_user xxxxxxxxxxxxxxxxxxx | ||
``` |