Skip to content

Commit

Permalink
fix documentation HCL syntax (#362)
Browse files Browse the repository at this point in the history
  • Loading branch information
paulvollmer authored Aug 17, 2020
1 parent bf0079b commit 525714f
Show file tree
Hide file tree
Showing 42 changed files with 186 additions and 186 deletions.
10 changes: 5 additions & 5 deletions docs/data_sources/keycloak_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,21 @@ resource "keycloak_realm" "realm" {
}
data "keycloak_role" "offline_access" {
realm_id = "${keycloak_realm.realm.id}"
realm_id = keycloak_realm.realm.id
name = "offline_access"
}
data "keycloak_group" "group" {
realm_id = "${keycloak_realm.realm.id}"
realm_id = keycloak_realm.realm.id
name = "group"
}
resource "keycloak_group_roles" "group_roles" {
realm_id = "${keycloak_realm.realm.id}"
group_id = "${data.keycloak_group.group.id}"
realm_id = keycloak_realm.realm.id
group_id = data.keycloak_group.group.id
role_ids = [
"${data.keycloak_role.offline_access.id}"
data.keycloak_role.offline_access.id
]
}
```
Expand Down
2 changes: 1 addition & 1 deletion docs/data_sources/keycloak_realm.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ data "keycloak_realm" "realm" {
# use the data source
resource "keycloak_role" "group" {
realm_id = "${data.keycloak_realm.realm.id}"
realm_id = data.keycloak_realm.realm.id
name = "group"
}
Expand Down
12 changes: 6 additions & 6 deletions docs/data_sources/keycloak_role.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,23 @@ resource "keycloak_realm" "realm" {
}
data "keycloak_role" "offline_access" {
realm_id = "${keycloak_realm.realm.id}"
realm_id = keycloak_realm.realm.id
name = "offline_access"
}
# use the data source
resource "keycloak_group" "group" {
realm_id = "${keycloak_realm.realm.id}"
realm_id = keycloak_realm.realm.id
name = "group"
}
resource "keycloak_group_roles" "group_roles" {
realm_id = "${keycloak_realm.realm.id}"
group_id = "${keycloak_group.group.id}"
realm_id = keycloak_realm.realm.id
group_id = keycloak_group.group.id
role_ids = [
"${data.keycloak_role.offline_access.id}"
data.keycloak_role.offline_access.id
]
}
```
Expand All @@ -41,7 +41,7 @@ The following arguments are supported:
- `client_id` - (Optional) When specified, this role is assumed to be a
client role belonging to the client with the provided ID
- `name` - (Required) The name of the role

### Attributes Reference

In addition to the arguments listed above, the following computed attributes are exported:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ of a SAML Client.

### Example Usage

In the example below, we extract the SAML metadata IDPSSODescriptor
In the example below, we extract the SAML metadata IDPSSODescriptor
to pass it to the AWS IAM SAML Provider.

```hcl
Expand All @@ -15,7 +15,7 @@ resource "keycloak_realm" "realm" {
}
resource "keycloak_saml_client" "saml_client" {
realm_id = "${keycloak_realm.realm.id}"
realm_id = keycloak_realm.realm.id
client_id = "test-saml-client"
name = "test-saml-client"
Expand All @@ -28,8 +28,8 @@ resource "keycloak_saml_client" "saml_client" {
}
data "keycloak_saml_client_installation_provider" "saml_idp_descriptor" {
realm_id = "${keycloak_realm.realm.id}"
client_id = "${keycloak_saml_client.saml_client}"
realm_id = keycloak_realm.realm.id
client_id = keycloak_saml_client.saml_client
provider_id = "saml-idp-descriptor"
}
Expand Down
6 changes: 3 additions & 3 deletions docs/resources/keycloak_authentication_execution.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ resource "keycloak_realm" "realm" {
}
resource "keycloak_authentication_flow" "flow" {
realm_id = "${keycloak_realm.realm.id}"
realm_id = keycloak_realm.realm.id
alias = "my-flow-alias"
}
resource "keycloak_authentication_execution" "execution" {
realm_id = "${keycloak_realm.realm.id}"
parent_flow_alias = "${keycloak_authentication_flow.flow.alias}"
realm_id = keycloak_realm.realm.id
parent_flow_alias = keycloak_authentication_flow.flow.alias
authenticator = "identity-provider-redirector"
requirement = "REQUIRED"
}
Expand Down
10 changes: 5 additions & 5 deletions docs/resources/keycloak_authentication_execution_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,19 @@ resource "keycloak_realm" "realm" {
}
resource "keycloak_authentication_flow" "flow" {
realm_id = "${keycloak_realm.realm.id}"
realm_id = keycloak_realm.realm.id
alias = "my-flow-alias"
}
resource "keycloak_authentication_execution" "execution" {
realm_id = "${keycloak_realm.realm.id}"
parent_flow_alias = "${keycloak_authentication_flow.flow.alias}"
realm_id = keycloak_realm.realm.id
parent_flow_alias = keycloak_authentication_flow.flow.alias
authenticator = "identity-provider-redirector"
}
resource "keycloak_authentication_execution_config" "config" {
realm_id = "${keycloak_realm.realm.id}"
execution_id = "${keycloak_authentication_execution.execution.id}"
realm_id = keycloak_realm.realm.id
execution_id = keycloak_authentication_execution.execution.id
alias = "my-config-alias"
config = {
defaultProvider = "my-config-default-idp"
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/keycloak_custom_user_federation.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ resource "keycloak_realm" "realm" {
resource "keycloak_custom_user_federation" "custom_user_federation" {
name = "custom"
realm_id = "${keycloak_realm.realm.id}"
realm_id = keycloak_realm.realm.id
provider_id = "custom"
enabled = true
Expand Down
10 changes: 5 additions & 5 deletions docs/resources/keycloak_default_groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ resource "keycloak_realm" "realm" {
}
resource "keycloak_group" "group" {
realm_id = "${keycloak_realm.realm.id}"
realm_id = keycloak_realm.realm.id
name = "my-group"
}
resource "keycloak_default_groups" "default" {
realm_id = "${keycloak_realm.realm.id}"
group_ids = ["${keycloak_group.group.id}"]
}
realm_id = keycloak_realm.realm.id
group_ids = [keycloak_group.group.id]
}
```

### Argument Reference
Expand All @@ -39,4 +39,4 @@ Example:

```bash
$ terraform import keycloak_default_groups.default my-realm
```
```
8 changes: 4 additions & 4 deletions docs/resources/keycloak_generic_client_protocol_mapper.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ There are two uses cases for using this resource:
* If you implemented a custom protocol mapper, this resource can be used to configure it
* If the provider doesn't support a particular protocol mapper, this resource can be used instead.

Due to the generic nature of this mapper, it is less user-friendly and more prone to configuration errors.
Due to the generic nature of this mapper, it is less user-friendly and more prone to configuration errors.
Therefore, if possible, a specific mapper should be used.

### Example Usage
Expand All @@ -18,13 +18,13 @@ resource "keycloak_realm" "realm" {
}
resource "keycloak_saml_client" "saml_client" {
realm_id = "${keycloak_realm.realm.id}"
realm_id = keycloak_realm.realm.id
client_id = "test-client"
}
resource "keycloak_generic_client_protocol_mapper" "saml_hardcode_attribute_mapper" {
realm_id = "${keycloak_realm.realm.id}"
client_id = "${keycloak_saml_client.saml_client.id}"
realm_id = keycloak_realm.realm.id
client_id = keycloak_saml_client.saml_client.id
name = "tes-mapper"
protocol = "saml"
protocol_mapper = "saml-hardcode-attribute-mapper"
Expand Down
10 changes: 5 additions & 5 deletions docs/resources/keycloak_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,19 @@ resource "keycloak_realm" "realm" {
}
resource "keycloak_group" "parent_group" {
realm_id = "${keycloak_realm.realm.id}"
realm_id = keycloak_realm.realm.id
name = "parent-group"
}
resource "keycloak_group" "child_group" {
realm_id = "${keycloak_realm.realm.id}"
parent_id = "${keycloak_group.parent_group.id}"
realm_id = keycloak_realm.realm.id
parent_id = keycloak_group.parent_group.id
name = "child-group"
}
resource "keycloak_group" "child_group_with_optional_attributes" {
realm_id = "${keycloak_realm.realm.id}"
parent_id = "${keycloak_group.parent_group.id}"
realm_id = keycloak_realm.realm.id
parent_id = keycloak_group.parent_group.id
name = "child-group-with-optional-attributes"
attributes = {
"key1" = "value1"
Expand Down
10 changes: 5 additions & 5 deletions docs/resources/keycloak_group_memberships.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,21 +23,21 @@ resource "keycloak_realm" "realm" {
}
resource "keycloak_group" "group" {
realm_id = "${keycloak_realm.realm.id}"
realm_id = keycloak_realm.realm.id
name = "my-group"
}
resource "keycloak_user" "user" {
realm_id = "${keycloak_realm.realm.id}"
realm_id = keycloak_realm.realm.id
username = "my-user"
}
resource "keycloak_group_memberships" "group_members" {
realm_id = "${keycloak_realm.realm.id}"
group_id = "${keycloak_group.group.id}"
realm_id = keycloak_realm.realm.id
group_id = keycloak_group.group.id
members = [
"${keycloak_user.user.username}"
keycloak_user.user.username
]
}
```
Expand Down
20 changes: 10 additions & 10 deletions docs/resources/keycloak_group_roles.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ resource "keycloak_realm" "realm" {
}
resource "keycloak_role" "realm_role" {
realm_id = "${keycloak_realm.realm.id}"
realm_id = keycloak_realm.realm.id
name = "my-realm-role"
description = "My Realm Role"
}
resource "keycloak_openid_client" "client" {
realm_id = "${keycloak_realm.realm.id}"
realm_id = keycloak_realm.realm.id
client_id = "client"
name = "client"
Expand All @@ -37,24 +37,24 @@ resource "keycloak_openid_client" "client" {
}
resource "keycloak_role" "client_role" {
realm_id = "${keycloak_realm.realm.id}"
client_id = "${keycloak_client.client.id}"
realm_id = keycloak_realm.realm.id
client_id = keycloak_client.client.id
name = "my-client-role"
description = "My Client Role"
}
resource "keycloak_group" "group" {
realm_id = "${keycloak_realm.realm.id}"
realm_id = keycloak_realm.realm.id
name = "my-group"
}
resource "keycloak_group_roles" "group_roles" {
realm_id = "${keycloak_realm.realm.id}"
group_id = "${keycloak_group.group.id}"
realm_id = keycloak_realm.realm.id
group_id = keycloak_group.group.id
role_ids = [
"${keycloak_role.realm_role.id}",
"${keycloak_role.client_role.id}",
keycloak_role.realm_role.id,
keycloak_role.client_role.id,
]
}
```
Expand Down
6 changes: 3 additions & 3 deletions docs/resources/keycloak_ldap_full_name_mapper.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ resource "keycloak_realm" "realm" {
resource "keycloak_ldap_user_federation" "ldap_user_federation" {
name = "openldap"
realm_id = "${keycloak_realm.realm.id}"
realm_id = keycloak_realm.realm.id
username_ldap_attribute = "cn"
rdn_ldap_attribute = "cn"
Expand All @@ -32,8 +32,8 @@ resource "keycloak_ldap_user_federation" "ldap_user_federation" {
}
resource "keycloak_ldap_full_name_mapper" "ldap_full_name_mapper" {
realm_id = "${keycloak_realm.realm.id}"
ldap_user_federation_id = "${keycloak_ldap_user_federation.ldap_user_federation.id}"
realm_id = keycloak_realm.realm.id
ldap_user_federation_id = keycloak_ldap_user_federation.ldap_user_federation.id
name = "full-name-mapper"
ldap_full_name_attribute = "cn"
}
Expand Down
6 changes: 3 additions & 3 deletions docs/resources/keycloak_ldap_group_mapper.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ resource "keycloak_realm" "realm" {
resource "keycloak_ldap_user_federation" "ldap_user_federation" {
name = "openldap"
realm_id = "${keycloak_realm.realm.id}"
realm_id = keycloak_realm.realm.id
username_ldap_attribute = "cn"
rdn_ldap_attribute = "cn"
Expand All @@ -33,8 +33,8 @@ resource "keycloak_ldap_user_federation" "ldap_user_federation" {
}
resource "keycloak_ldap_group_mapper" "ldap_group_mapper" {
realm_id = "${keycloak_realm.realm.id}"
ldap_user_federation_id = "${keycloak_ldap_user_federation.ldap_user_federation.id}"
realm_id = keycloak_realm.realm.id
ldap_user_federation_id = keycloak_ldap_user_federation.ldap_user_federation.id
name = "group-mapper"
ldap_groups_dn = "dc=example,dc=org"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ resource "keycloak_realm" "realm" {
resource "keycloak_ldap_user_federation" "ldap_user_federation" {
name = "ad"
realm_id = "${keycloak_realm.realm.id}"
realm_id = keycloak_realm.realm.id
username_ldap_attribute = "cn"
rdn_ldap_attribute = "cn"
Expand All @@ -35,8 +35,8 @@ resource "keycloak_ldap_user_federation" "ldap_user_federation" {
}
resource "keycloak_ldap_msad_lds_user_account_control_mapper" "msad_lds_user_account_control_mapper" {
realm_id = "${keycloak_realm.realm.id}"
ldap_user_federation_id = "${keycloak_ldap_user_federation.ldap_user_federation.id}"
realm_id = keycloak_realm.realm.id
ldap_user_federation_id = keycloak_ldap_user_federation.ldap_user_federation.id
name = "msad-lds-user-account-control-mapper"
}
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ resource "keycloak_realm" "realm" {
resource "keycloak_ldap_user_federation" "ldap_user_federation" {
name = "ad"
realm_id = "${keycloak_realm.realm.id}"
realm_id = keycloak_realm.realm.id
username_ldap_attribute = "cn"
rdn_ldap_attribute = "cn"
Expand All @@ -35,8 +35,8 @@ resource "keycloak_ldap_user_federation" "ldap_user_federation" {
}
resource "keycloak_ldap_msad_user_account_control_mapper" "msad_user_account_control_mapper" {
realm_id = "${keycloak_realm.realm.id}"
ldap_user_federation_id = "${keycloak_ldap_user_federation.ldap_user_federation.id}"
realm_id = keycloak_realm.realm.id
ldap_user_federation_id = keycloak_ldap_user_federation.ldap_user_federation.id
name = "msad-user-account-control-mapper"
}
```
Expand Down
Loading

0 comments on commit 525714f

Please sign in to comment.