KeycloakFunctions

Functions

Link copied to clipboard

This data source can be used to fetch the ID of an authentication execution within Keycloak.

suspend fun getAuthenticationExecution(parentFlowAlias: String, providerId: String, realmId: String): GetAuthenticationExecutionResult
Link copied to clipboard

This data source can be used to fetch the ID of an authentication flow within Keycloak.

Link copied to clipboard

This data source uses the ClientDescriptionConverter API to convert a generic client description into a Keycloak client. This data can then be used to manage the client within Keycloak.

Link copied to clipboard
suspend fun getGroup(argument: GetGroupPlainArgs): GetGroupResult

This data source can be used to fetch properties of a Keycloak group for usage with other resources, such as keycloak.GroupRoles.

suspend fun getGroup(argument: suspend GetGroupPlainArgsBuilder.() -> Unit): GetGroupResult
suspend fun getGroup(name: String, realmId: String): GetGroupResult
Link copied to clipboard
suspend fun getRealm(argument: GetRealmPlainArgs): GetRealmResult

This data source can be used to fetch properties of a Keycloak realm for usage with other resources.

suspend fun getRealm(argument: suspend GetRealmPlainArgsBuilder.() -> Unit): GetRealmResult
suspend fun getRealm(attributes: Map<String, String>? = null, defaultDefaultClientScopes: List<String>? = null, defaultOptionalClientScopes: List<String>? = null, displayNameHtml: String? = null, internationalizations: List<GetRealmInternationalization>? = null, otpPolicy: GetRealmOtpPolicy? = null, realm: String, securityDefenses: List<GetRealmSecurityDefense>? = null, smtpServers: List<GetRealmSmtpServer>? = null, webAuthnPasswordlessPolicy: GetRealmWebAuthnPasswordlessPolicy? = null, webAuthnPolicy: GetRealmWebAuthnPolicy? = null): GetRealmResult
Link copied to clipboard

Use this data source to get the keys of a realm. Keys can be filtered by algorithm and status. Remarks:

suspend fun getRealmKeys(algorithms: List<String>? = null, realmId: String, statuses: List<String>? = null): GetRealmKeysResult
Link copied to clipboard
suspend fun getRole(argument: GetRolePlainArgs): GetRoleResult

This data source can be used to fetch properties of a Keycloak role for usage with other resources, such as keycloak.GroupRoles.

suspend fun getRole(argument: suspend GetRolePlainArgsBuilder.() -> Unit): GetRoleResult
suspend fun getRole(clientId: String? = null, name: String, realmId: String): GetRoleResult
Link copied to clipboard
suspend fun getUser(argument: GetUserPlainArgs): GetUserResult

This data source can be used to fetch properties of a user within Keycloak.

suspend fun getUser(argument: suspend GetUserPlainArgsBuilder.() -> Unit): GetUserResult
suspend fun getUser(realmId: String, username: String): GetUserResult
Link copied to clipboard

This data source can be used to fetch the realm roles of a user within Keycloak.

suspend fun getUserRealmRoles(realmId: String, userId: String): GetUserRealmRolesResult