Skip to content

Commit 9e9f1ae

Browse files
committed
Add user data docs
1 parent 5ed40b2 commit 9e9f1ae

File tree

2 files changed

+73
-0
lines changed

2 files changed

+73
-0
lines changed

docs/data/user.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# User Data Source
2+
3+
Use this data source to get the User from existing users for use in other resources.
4+
5+
## Example usage
6+
7+
```hcl
8+
data "codefresh_user" "admin" {
9+
10+
}
11+
12+
resource "codefresh_team" "admins" {
13+
14+
name = "testsuperteam123"
15+
16+
users = [
17+
data.codefresh_user.admin.user_id,
18+
"<ANY USER ID>",
19+
]
20+
}
21+
```
22+
23+
## Argument Reference
24+
25+
- `email` - (Required) The email of user to filter.
26+
27+
## Attributes Reference
28+
29+
- `user_name`.
30+
- `email`.
31+
- `user_id`.
32+
- `personal`. A collection of `personal` blocks as documented below.
33+
- `short_profile`. A collection of `short_profile` blocks as documented below.
34+
- `roles`. A list of roles.
35+
- `status`. User status - `new`, `pending`, etc.
36+
- `logins`. A collection of `short_profile` blocks as documented below.
37+
38+
---
39+
40+
`personal` includes the following:
41+
- `first_name`.
42+
- `last_name`.
43+
- `company_name`.
44+
- `phone_number`.
45+
- `country`.
46+
47+
---
48+
49+
`short_profile` includes the following:
50+
- `user_name`.
51+
52+
---
53+
54+
`logins` includes the following:
55+
- `credentials`
56+
- `permissions`
57+
- `idp`
58+
- `id`
59+
- `client_type

docs/data/users.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
`# Users Data Source
2+
3+
Use this data source to get all existing users from Codefresh.
4+
5+
## Example usage
6+
7+
```hcl
8+
data "codefresh_users" "users" {}
9+
}
10+
```
11+
12+
## Attributes Reference
13+
14+
- `users` - A list of [user](./user.md)

0 commit comments

Comments
 (0)