Skip to content

Commit f6f9481

Browse files
authored
[Doc] Explicitly mention SCIM ID in databricks_group_member docs (#4709)
## Changes <!-- Summary of your changes that are easy to understand --> It looks like customers are confused what ID should be used in `databricks_group_member` resource, so it makes sense to explicitly mention that it's SCIM ID. Resolves #4194 ## Tests <!-- How is this tested? Please see the checklist below and also describe any other relevant tests --> - [ ] `make test` run locally - [x] relevant change in `docs/` folder - [ ] covered with integration tests in `internal/acceptance` - [ ] using Go SDK - [ ] using TF Plugin Framework
1 parent cd1081a commit f6f9481

File tree

5 files changed

+10
-8
lines changed

5 files changed

+10
-8
lines changed

NEXT_CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88

99
### Documentation
1010

11+
* Explicitly mention SCIM ID in `databricks_group_member` docs [#4709](https://github.com/databricks/terraform-provider-databricks/pull/4709)
12+
1113
### Exporter
1214

1315
### Internal Changes

docs/resources/group.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,12 +101,12 @@ The following arguments are supported:
101101

102102
In addition to all arguments above, the following attributes are exported:
103103

104-
* `id` - The id for the group object.
104+
* `id` - Canonical unique identifier for the group (SCIM ID).
105105
* `acl_principal_id` - identifier for use in [databricks_access_control_rule_set](access_control_rule_set.md), e.g. `groups/Some Group`.
106106

107107
## Import
108108

109-
You can import a `databricks_group` resource with the name `my_group` like the following:
109+
You can import a `databricks_group` resource by its SCIM ID:
110110

111111
```hcl
112112
import {

docs/resources/group_member.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ resource "databricks_group_member" "bb" {
4141

4242
The following arguments are supported:
4343

44-
* `group_id` - (Required) This is the id of the [group](group.md) resource.
45-
* `member_id` - (Required) This is the id of the [group](group.md), [service principal](service_principal.md), or [user](user.md).
44+
* `group_id` - (Required) This is the `id` attribute (SCIM ID) of the [group](group.md) resource.
45+
* `member_id` - (Required) This is the `id` attribute (SCIM ID) of the [group](group.md), [service principal](service_principal.md), or [user](user.md).
4646

4747
## Attribute Reference
4848

docs/resources/service_principal.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,14 +114,14 @@ The following arguments are available:
114114

115115
In addition to all arguments above, the following attributes are exported:
116116

117-
- `id` - Canonical unique identifier for the service principal.
117+
- `id` - Canonical unique identifier for the service principal (SCIM ID).
118118
- `home` - Home folder of the service principal, e.g. `/Users/00000000-0000-0000-0000-000000000000`.
119119
- `repos` - Personal Repos location of the service principal, e.g. `/Repos/00000000-0000-0000-0000-000000000000`.
120120
- `acl_principal_id` - identifier for use in [databricks_access_control_rule_set](access_control_rule_set.md), e.g. `servicePrincipals/00000000-0000-0000-0000-000000000000`.
121121

122122
## Import
123123

124-
The resource scim service principal can be imported using its id, for example `2345678901234567`. To get the service principal ID, call [Get service principals](https://docs.databricks.com/dev-tools/api/latest/scim/scim-sp.html#get-service-principals).
124+
The resource scim service principal can be imported using its SCIM id, for example `2345678901234567`. To get the service principal ID, call [Get service principals](https://docs.databricks.com/dev-tools/api/latest/scim/scim-sp.html#get-service-principals).
125125

126126
```hcl
127127
import {

docs/resources/user.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,14 +109,14 @@ The following arguments are available:
109109

110110
In addition to all arguments above, the following attributes are exported:
111111

112-
* `id` - Canonical unique identifier for the user.
112+
* `id` - Canonical unique identifier for the user (SCIM ID).
113113
* `home` - Home folder of the user, e.g. `/Users/[email protected]`.
114114
* `repos` - Personal Repos location of the user, e.g. `/Repos/[email protected]`.
115115
* `acl_principal_id` - identifier for use in [databricks_access_control_rule_set](access_control_rule_set.md), e.g. `users/[email protected]`.
116116

117117
## Import
118118

119-
The resource scim user can be imported using id:
119+
The resource scim user can be imported using its SCIM id:
120120

121121
```hcl
122122
import {

0 commit comments

Comments
 (0)