Skip to content

Commit

Permalink
Add documentation for the new attribute
Browse files Browse the repository at this point in the history
  • Loading branch information
Isabella Dix committed Sep 26, 2024
1 parent c5e0a76 commit 1606b17
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/resources/authentication_execution.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ resource "keycloak_authentication_execution" "execution_two" {
- `parent_flow_alias` - (Required) The alias of the flow this execution is attached to.
- `authenticator` - (Required) The name of the authenticator. This can be found by experimenting with the GUI and looking at HTTP requests within the network tab of your browser's development tools.
- `requirement`- (Optional) The requirement setting, which can be one of `REQUIRED`, `ALTERNATIVE`, `OPTIONAL`, `CONDITIONAL`, or `DISABLED`. Defaults to `DISABLED`.
- `import` - (Optional) When `true`, the authentication execution with the specified `authenticator` inside the authentication flow with the specified alias `parent_flow_alias` is assumed to already exist, and it will be imported into state instead of being created. This attribute is useful when dealing with authentication executions that Keycloak creates automatically during realm creation, such as `browser/identity-provider-redirector` and `registration/registration-user-creation`. Note, that the execution will not be removed during destruction if `import` is `true`.

## Import

Expand Down
2 changes: 2 additions & 0 deletions docs/resources/authentication_flow.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ resource "keycloak_authentication_execution" "execution" {
- `alias` - (Required) The alias for this authentication flow.
- `description` - (Optional) A description for the authentication flow.
- `provider_id` - (Optional) The type of authentication flow to create. Valid choices include `basic-flow` and `client-flow`. Defaults to `basic-flow`.
- `import` - (Optional) When `true`, the authentication flow with the specified `alias` is assumed to already exist, and it will be imported into state instead of being created. This attribute is useful when dealing with authentication flows that Keycloak creates automatically during realm creation, such as `browser` and `clients`. Note, that the flow will not be removed during destruction if `import` is `true`.


## Import

Expand Down
1 change: 1 addition & 0 deletions docs/resources/authentication_subflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ and `client-flow`. Defaults to `basic-flow`.
authenticators. In general this will remain empty.
- `requirement`- (Optional) The requirement setting, which can be one of `REQUIRED`, `ALTERNATIVE`, `OPTIONAL`, `CONDITIONAL`,
or `DISABLED`. Defaults to `DISABLED`.
- `import` - (Optional) When `true`, the authentication subflow with the specified `alias` inside the parent flow with the specified alias `parent_flow_alias` is assumed to already exist, and it will be imported into state instead of being created. This attribute is useful when dealing with authentication subflows that Keycloak creates automatically during realm creation, such as `browser/forms` and `first broker login/User creation of linking`. Note, that the subflow will not be removed during destruction if `import` is `true`.

## Import

Expand Down

0 comments on commit 1606b17

Please sign in to comment.