Skip to content

Commit 7902dce

Browse files
authored
Document client roles in default roles (#1295)
Signed-off-by: Ingo Kuba <[email protected]>
1 parent d0d8289 commit 7902dce

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

docs/resources/default_roles.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ page_title: "keycloak_default_roles Resource"
44

55
# keycloak\_default\_roles Resource
66

7-
Allows managing default realm roles within Keycloak.
7+
Allows managing default roles within Keycloak.
88

99
Note: This feature was added in Keycloak v13, so this resource will not work on older versions of Keycloak.
1010

@@ -22,10 +22,24 @@ resource "keycloak_default_roles" "default_roles" {
2222
}
2323
```
2424

25+
## Example Usage (Client roles)
26+
27+
```hcl
28+
resource "keycloak_realm" "realm" {
29+
realm = "my-realm"
30+
enabled = true
31+
}
32+
33+
resource "keycloak_default_roles" "default_roles" {
34+
realm_id = keycloak_realm.realm.id
35+
default_roles = ["account/manage-account", "account/view-groups"]
36+
}
37+
```
38+
2539
## Argument Reference
2640

2741
- `realm_id` - (Required) The realm this role exists within.
28-
- `default_roles` - (Required) Realm level roles assigned to new users by default.
42+
- `default_roles` - (Required) Roles assigned to new users by default.
2943

3044
## Import
3145

0 commit comments

Comments
 (0)