Skip to content

Document Possible Required Actions #1206

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document Possible Required Actions #1206

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/resources/user.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,19 @@ resource "keycloak_user" "user_with_initial_password" {
- `user_name` - (Required) The username of the user defined in the identity provider
- `import` - (Optional) When `true`, the user with the specified `username` is assumed to already exist, and it will be imported into state instead of being created. This attribute is useful when dealing with users that Keycloak creates automatically during realm creation, such as `admin`. Note, that the user will not be removed during destruction if `import` is `true`.

## Valid Required Actions:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would rather not add these actions in an extra section but stick to the standard format listing the options in the description of the parameter with "Valid options are: CONFIGURE_TOTP, ..." I would also use the order as defined by Keycloak in its source code, makes it easier to maintain and spot differences, see https://github.com/keycloak/keycloak/blob/b9442b169066f93977a6e8b22a4b76b2e7b86c94/server-spi-private/src/main/java/org/keycloak/models/utils/DefaultRequiredActions.java#L74-L86

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MrHPotter are you still interested in landing this?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I liked your ideas for improvement. Woll just have to remember at a time where i can put it into action. If you know where and how you'd like it i would not be offended if you took pver either and just did it tho.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is now another PR also adding some extended information https://github.com/keycloak/terraform-provider-keycloak/pull/1308/files. I think we will just go with this.

"CONFIGURE_TOTP"
"TERMS_AND_CONDITIONS"
"UPDATE_PASSWORD"
"UPDATE_PROFILE"
"VERIFY_EMAIL"
"delete_account"
"webauthn-register"
"webauthn-register-passwordless"
"VERIFY_PROFILE"
"delete_credential"
"update_user_locale"

## Import

Users can be imported using the format `{{realm_id}}/{{user_id}}`, where `user_id` is the unique ID that Keycloak
Expand Down