Skip to content

Commit cb2d847

Browse files
committed
Update docs
1 parent f094147 commit cb2d847

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

docs/resources/iam_user.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ For more information, see the [API documentation](https://www.scaleway.com/en/de
1414

1515
```terraform
1616
resource "scaleway_iam_user" "guest" {
17-
email = "test@test.com"
17+
email = "foo@test.com"
1818
tags = ["test-tag"]
1919
}
2020
```
@@ -23,13 +23,15 @@ resource "scaleway_iam_user" "guest" {
2323

2424
```terraform
2525
resource "scaleway_iam_user" "member" {
26-
27-
tags = ["test-tag"]
28-
username = "test"
26+
27+
tags = ["test-tag"]
28+
username = "foo"
29+
first_name = "Foo"
30+
last_name = "Bar"
2931
}
3032
```
3133

32-
When username is set, the user is created as a [Member](https://www.scaleway.com/en/docs/iam/concepts/#member). Otherwise, it is created as a [Guest](https://www.scaleway.com/en/docs/iam/concepts/#guest).
34+
When `username` is set, the user is created as a [Member](https://www.scaleway.com/en/docs/iam/concepts/#member). Otherwise, it is created as a [Guest](https://www.scaleway.com/en/docs/iam/concepts/#guest).
3335

3436
### Multiple users
3537

@@ -49,17 +51,17 @@ resource "scaleway_iam_user" "user" {
4951

5052
## Argument Reference
5153

52-
- `email` - (Required) The email of the IAM user.
54+
- `organization_id` - (Defaults to [provider](../index.md#organization_id) `organization_id`) The ID of the organization the user is associated with.
5355

54-
- `tags` - (Optional) The tags associated with the user.
56+
- `email` - (Required) The email of the IAM user. For Guest users, this argument is not editable.
5557

56-
- `organization_id` - (Defaults to [provider](../index.md#organization_d) `organization_id`) The ID of the organization the user is associated with.
58+
- `tags` - (Optional) The tags associated with the user.
5759

5860
- `username` - (Optional) The username of the IAM user. When it is set, the user is created as a Member. When it is not set, the user is created as a Guest and the username is set as equal to the email.
5961

60-
- `password` - The password for first access. It gets ignored if the user is a Guest.
62+
- `password` - The password for first access.
6163

62-
- `send_password_email` - Whether or not to send an email containing the member's password.
64+
- `send_password_email` - Whether or not to send an email containing the password for first access.
6365

6466
- `send_welcome_email` - Whether or not to send a welcome email that includes onboarding information.
6567

@@ -69,7 +71,9 @@ resource "scaleway_iam_user" "user" {
6971

7072
- `phone_number` - The user's phone number.
7173

72-
- `locale` - The user's locale (e.g. en_US).
74+
- `locale` - The user's locale (e.g., en_US).
75+
76+
Important: When creating a Guest user, all arguments are ignored, except for `organization_id`, `email` and `tags`.
7377

7478
## Attributes Reference
7579

0 commit comments

Comments
 (0)