Skip to content

Commit 484fe42

Browse files
modulimoduli
committed
doc: Add docs for new data sources
1 parent a792a3f commit 484fe42

File tree

42 files changed

+2468
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+2468
-0
lines changed

‎docs/data-sources/accounts.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "boundary_accounts Data Source - terraform-provider-boundary"
4+
subcategory: ""
5+
description: |-
6+
Lists accounts
7+
---
8+
9+
# boundary_accounts (Data Source)
10+
11+
Lists accounts
12+
13+
## Example Usage
14+
15+
```terraform
16+
# Retrieve Accounts
17+
data "boundary_accounts" "example" {
18+
auth_method_id = "id"
19+
}
20+
21+
# Retrieve Accounts with "test" in the name
22+
data "boundary_accounts" "example" {
23+
filter = "\"test\" in \"/item/name\""
24+
auth_method_id = "id"
25+
}
26+
```
27+
28+
<!-- schema generated by tfplugindocs -->
29+
## Schema
30+
31+
### Optional
32+
33+
- `auth_method_id` (String) The ID of the auth method whose accounts should be listed.
34+
- `filter` (String) You can specify that the filter should only return items that match.
35+
Refer to [filter expressions](https://developer.hashicorp.com/boundary/docs/concepts/filtering) for more information.
36+
- `list_token` (String) An opaque token that Boundary uses to continue an existing iteration or
37+
request updated items. If you do not specify a token, pagination
38+
starts from the beginning. To learn more about list pagination
39+
in Boundary, refer to [list pagination](https://developer.hashicorp.com/boundary/docs/api-clients/api/pagination).
40+
- `page_size` (Number) The maximum size of a page in this iteration.
41+
If you do not set a page size, Boundary uses the configured default page size.
42+
If the page_size is greater than the default page size configured,
43+
Boundary truncates the page size to this number.
44+
45+
### Read-Only
46+
47+
- `est_item_count` (Number) An estimate at the total items available. This may change during pagination.
48+
- `id` (String) The ID of this resource.
49+
- `items` (List of Object) The list of accounts. (see [below for nested schema](#nestedatt--items))
50+
- `removed_ids` (List of String) A list of item IDs that have been removed since they were returned
51+
as part of a pagination. They should be dropped from any client cache.
52+
This may contain items that are not known to the cache, if they were
53+
created and deleted between listings.
54+
- `response_type` (String) The type of response, either "delta" or "complete".
55+
Delta signifies that this is part of a paginated result
56+
or an update to a previously completed pagination.
57+
Complete signifies that it is the last page.
58+
- `sort_by` (String) The name of the field which the items are sorted by.
59+
- `sort_dir` (String) The direction of the sort, either "asc" or "desc".
60+
61+
<a id="nestedatt--items"></a>
62+
### Nested Schema for `items`
63+
64+
Read-Only:
65+
66+
- `auth_method_id` (String)
67+
- `authorized_actions` (List of String)
68+
- `created_time` (String)
69+
- `description` (String)
70+
- `id` (String)
71+
- `managed_group_ids` (List of String)
72+
- `name` (String)
73+
- `scope` (List of Object) (see [below for nested schema](#nestedobjatt--items--scope))
74+
- `type` (String)
75+
- `updated_time` (String)
76+
- `version` (Number)
77+
78+
<a id="nestedobjatt--items--scope"></a>
79+
### Nested Schema for `items.scope`
80+
81+
Read-Only:
82+
83+
- `description` (String)
84+
- `id` (String)
85+
- `name` (String)
86+
- `parent_scope_id` (String)
87+
- `type` (String)

‎docs/data-sources/aliases.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "boundary_aliases Data Source - terraform-provider-boundary"
4+
subcategory: ""
5+
description: |-
6+
Lists aliases
7+
---
8+
9+
# boundary_aliases (Data Source)
10+
11+
Lists aliases
12+
13+
## Example Usage
14+
15+
```terraform
16+
# Retrieve Aliases
17+
data "boundary_aliases" "example" {
18+
scope_id = "id"
19+
}
20+
21+
# Retrieve Aliases with "test" in the name
22+
data "boundary_aliases" "example" {
23+
filter = "\"test\" in \"/item/name\""
24+
scope_id = "id"
25+
}
26+
```
27+
28+
<!-- schema generated by tfplugindocs -->
29+
## Schema
30+
31+
### Optional
32+
33+
- `filter` (String) You can specify that the filter should only return items that match.
34+
Refer to [filter expressions](https://developer.hashicorp.com/boundary/docs/concepts/filtering) for more information.
35+
- `list_token` (String) An opaque token that Boundary uses to continue an existing iteration or
36+
request updated items. If you do not specify a token, pagination
37+
starts from the beginning. To learn more about list pagination
38+
in Boundary, refer to [list pagination](https://developer.hashicorp.com/boundary/docs/api-clients/api/pagination).
39+
- `page_size` (Number) The maximum size of a page in this iteration.
40+
If you do not set a page size, Boundary uses the configured default page size.
41+
If the page_size is greater than the default page size configured,
42+
Boundary truncates the page size to this number.
43+
- `recursive` (Boolean) Whether to recursively list aliases in the provided scope's child scopes.
44+
- `scope_id` (String) The ID of the scope in which to list aliases
45+
46+
### Read-Only
47+
48+
- `est_item_count` (Number) An estimate at the total items available. This may change during pagination.
49+
- `id` (String) The ID of this resource.
50+
- `items` (List of Object) The list of aliases. (see [below for nested schema](#nestedatt--items))
51+
- `removed_ids` (List of String) A list of item IDs that have been removed since they were returned
52+
as part of a pagination. They should be dropped from any client cache.
53+
This may contain items that are not known to the cache, if they were
54+
created and deleted between listings.
55+
- `response_type` (String) The type of response, either "delta" or "complete".
56+
Delta signifies that this is part of a paginated result
57+
or an update to a previously completed pagination.
58+
Complete signifies that it is the last page.
59+
- `sort_by` (String) The name of the field which the items are sorted by.
60+
- `sort_dir` (String) The direction of the sort, either "asc" or "desc".
61+
62+
<a id="nestedatt--items"></a>
63+
### Nested Schema for `items`
64+
65+
Read-Only:
66+
67+
- `authorized_actions` (List of String)
68+
- `created_time` (String)
69+
- `description` (String)
70+
- `destination_id` (String)
71+
- `id` (String)
72+
- `name` (String)
73+
- `scope` (List of Object) (see [below for nested schema](#nestedobjatt--items--scope))
74+
- `scope_id` (String)
75+
- `type` (String)
76+
- `updated_time` (String)
77+
- `value` (String)
78+
- `version` (Number)
79+
80+
<a id="nestedobjatt--items--scope"></a>
81+
### Nested Schema for `items.scope`
82+
83+
Read-Only:
84+
85+
- `description` (String)
86+
- `id` (String)
87+
- `name` (String)
88+
- `parent_scope_id` (String)
89+
- `type` (String)

‎docs/data-sources/auth_methods.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "boundary_auth_methods Data Source - terraform-provider-boundary"
4+
subcategory: ""
5+
description: |-
6+
Lists auth-methods
7+
---
8+
9+
# boundary_auth_methods (Data Source)
10+
11+
Lists auth-methods
12+
13+
## Example Usage
14+
15+
```terraform
16+
# Retrieve AuthMethods
17+
data "boundary_auth_methods" "example" {
18+
scope_id = "id"
19+
}
20+
21+
# Retrieve AuthMethods with "test" in the name
22+
data "boundary_auth_methods" "example" {
23+
filter = "\"test\" in \"/item/name\""
24+
scope_id = "id"
25+
}
26+
```
27+
28+
<!-- schema generated by tfplugindocs -->
29+
## Schema
30+
31+
### Optional
32+
33+
- `filter` (String) You can specify that the filter should only return items that match.
34+
Refer to [filter expressions](https://developer.hashicorp.com/boundary/docs/concepts/filtering) for more information.
35+
- `list_token` (String) An opaque token that Boundary uses to continue an existing iteration or
36+
request updated items. If you do not specify a token, pagination
37+
starts from the beginning. To learn more about list pagination
38+
in Boundary, refer to [list pagination](https://developer.hashicorp.com/boundary/docs/api-clients/api/pagination).
39+
- `page_size` (Number) The maximum size of a page in this iteration.
40+
If you do not set a page size, Boundary uses the configured default page size.
41+
If the page_size is greater than the default page size configured,
42+
Boundary truncates the page size to this number.
43+
- `recursive` (Boolean) Whether to recursively list auth methods in the provided scope's child scopes.
44+
- `scope_id` (String) The scope ID in which to list auth methods.
45+
46+
### Read-Only
47+
48+
- `est_item_count` (Number) An estimate at the total items available. This may change during pagination.
49+
- `id` (String) The ID of this resource.
50+
- `items` (List of Object) The items returned in this page. (see [below for nested schema](#nestedatt--items))
51+
- `removed_ids` (List of String) A list of item IDs that have been removed since they were returned
52+
as part of a pagination. They should be dropped from any client cache.
53+
This may contain items that are not known to the cache, if they were
54+
created and deleted between listings.
55+
- `response_type` (String) The type of response, either "delta" or "complete".
56+
Delta signifies that this is part of a paginated result
57+
or an update to a previously completed pagination.
58+
Complete signifies that it is the last page.
59+
- `sort_by` (String) The name of the field which the items are sorted by.
60+
- `sort_dir` (String) The direction of the sort, either "asc" or "desc".
61+
62+
<a id="nestedatt--items"></a>
63+
### Nested Schema for `items`
64+
65+
Read-Only:
66+
67+
- `authorized_actions` (List of String)
68+
- `created_time` (String)
69+
- `description` (String)
70+
- `id` (String)
71+
- `is_primary` (Boolean)
72+
- `name` (String)
73+
- `scope` (List of Object) (see [below for nested schema](#nestedobjatt--items--scope))
74+
- `scope_id` (String)
75+
- `type` (String)
76+
- `updated_time` (String)
77+
- `version` (Number)
78+
79+
<a id="nestedobjatt--items--scope"></a>
80+
### Nested Schema for `items.scope`
81+
82+
Read-Only:
83+
84+
- `description` (String)
85+
- `id` (String)
86+
- `name` (String)
87+
- `parent_scope_id` (String)
88+
- `type` (String)

‎docs/data-sources/auth_tokens.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "boundary_auth_tokens Data Source - terraform-provider-boundary"
4+
subcategory: ""
5+
description: |-
6+
Lists auth-tokens
7+
---
8+
9+
# boundary_auth_tokens (Data Source)
10+
11+
Lists auth-tokens
12+
13+
## Example Usage
14+
15+
```terraform
16+
# Retrieve AuthTokens
17+
data "boundary_auth_tokens" "example" {
18+
scope_id = "id"
19+
}
20+
21+
# Retrieve AuthTokens with "test" in the name
22+
data "boundary_auth_tokens" "example" {
23+
filter = "\"test\" in \"/item/name\""
24+
scope_id = "id"
25+
}
26+
```
27+
28+
<!-- schema generated by tfplugindocs -->
29+
## Schema
30+
31+
### Optional
32+
33+
- `filter` (String) You can specify that the filter should only return items that match.
34+
Refer to [filter expressions](https://developer.hashicorp.com/boundary/docs/concepts/filtering) for more information.
35+
- `list_token` (String) An opaque token that Boundary uses to continue an existing iteration or
36+
request updated items. If you do not specify a token, pagination
37+
starts from the beginning. To learn more about list pagination
38+
in Boundary, refer to [list pagination](https://developer.hashicorp.com/boundary/docs/api-clients/api/pagination).
39+
- `page_size` (Number) The maximum size of a page in this iteration.
40+
If you do not set a page size, Boundary uses the configured default page size.
41+
If the page_size is greater than the default page size configured,
42+
Boundary truncates the page size to this number.
43+
- `recursive` (Boolean)
44+
- `scope_id` (String)
45+
46+
### Read-Only
47+
48+
- `est_item_count` (Number) An estimate at the total items available. This may change during pagination.
49+
- `id` (String) The ID of this resource.
50+
- `items` (List of Object) (see [below for nested schema](#nestedatt--items))
51+
- `removed_ids` (List of String) A list of item IDs that have been removed since they were returned
52+
as part of a pagination. They should be dropped from any client cache.
53+
This may contain items that are not known to the cache, if they were
54+
created and deleted between listings.
55+
- `response_type` (String) The type of response, either "delta" or "complete".
56+
Delta signifies that this is part of a paginated result
57+
or an update to a previously completed pagination.
58+
Complete signifies that it is the last page.
59+
- `sort_by` (String) The name of the field which the items are sorted by.
60+
- `sort_dir` (String) The direction of the sort, either "asc" or "desc".
61+
62+
<a id="nestedatt--items"></a>
63+
### Nested Schema for `items`
64+
65+
Read-Only:
66+
67+
- `account_id` (String)
68+
- `approximate_last_used_time` (String)
69+
- `auth_method_id` (String)
70+
- `authorized_actions` (List of String)
71+
- `created_time` (String)
72+
- `expiration_time` (String)
73+
- `id` (String)
74+
- `scope` (List of Object) (see [below for nested schema](#nestedobjatt--items--scope))
75+
- `scope_id` (String)
76+
- `token` (String)
77+
- `updated_time` (String)
78+
- `user_id` (String)
79+
80+
<a id="nestedobjatt--items--scope"></a>
81+
### Nested Schema for `items.scope`
82+
83+
Read-Only:
84+
85+
- `description` (String)
86+
- `id` (String)
87+
- `name` (String)
88+
- `parent_scope_id` (String)
89+
- `type` (String)

0 commit comments

Comments
 (0)