Package-level declarations

Types

Link copied to clipboard
class Bindings : KotlinCustomResource

Allows for creating and managing realm authentication flow bindings within Keycloak. Authentication flows describe a sequence of actions that a user or service must perform in order to be authenticated to Keycloak. The authentication flow itself is a container for these actions, which are otherwise known as executions. Realms assign authentication flows to supported user flows such as registration and browser. This resource allows the updating of realm authentication flow bindings to custom authentication flows created by keycloak.authentication.Flow. Note that you can also use the keycloak.Realm resource to assign authentication flow bindings at the realm level. This resource is useful if you would like to create a realm and an authentication flow, and assign this flow to the realm within a single run of pulumi up. In any case, do not attempt to use both the arguments within the keycloak.Realm resource and this resource to manage authentication flow bindings, you should choose one or the other.

Link copied to clipboard
data class BindingsArgs(val browserFlow: Output<String>? = null, val clientAuthenticationFlow: Output<String>? = null, val directGrantFlow: Output<String>? = null, val dockerAuthenticationFlow: Output<String>? = null, val firstBrokerLoginFlow: Output<String>? = null, val realmId: Output<String>? = null, val registrationFlow: Output<String>? = null, val resetCredentialsFlow: Output<String>? = null) : ConvertibleToJava<BindingsArgs>

Allows for creating and managing realm authentication flow bindings within Keycloak. Authentication flows describe a sequence of actions that a user or service must perform in order to be authenticated to Keycloak. The authentication flow itself is a container for these actions, which are otherwise known as executions. Realms assign authentication flows to supported user flows such as registration and browser. This resource allows the updating of realm authentication flow bindings to custom authentication flows created by keycloak.authentication.Flow. Note that you can also use the keycloak.Realm resource to assign authentication flow bindings at the realm level. This resource is useful if you would like to create a realm and an authentication flow, and assign this flow to the realm within a single run of pulumi up. In any case, do not attempt to use both the arguments within the keycloak.Realm resource and this resource to manage authentication flow bindings, you should choose one or the other.

Link copied to clipboard
Link copied to clipboard
object BindingsMapper : ResourceMapper<Bindings>
Link copied to clipboard
Link copied to clipboard
class Execution : KotlinCustomResource

Allows for creating and managing an authentication execution within Keycloak. An authentication execution is an action that the user or service may or may not take when authenticating through an authentication flow.

Link copied to clipboard
data class ExecutionArgs(val authenticator: Output<String>? = null, val parentFlowAlias: Output<String>? = null, val priority: Output<Int>? = null, val realmId: Output<String>? = null, val requirement: Output<String>? = null) : ConvertibleToJava<ExecutionArgs>

Allows for creating and managing an authentication execution within Keycloak. An authentication execution is an action that the user or service may or may not take when authenticating through an authentication flow.

Link copied to clipboard
Link copied to clipboard
class ExecutionConfig : KotlinCustomResource

Allows for managing an authentication execution's configuration. If a particular authentication execution supports additional configuration (such as with the identity-provider-redirector execution), this can be managed with this resource.

Link copied to clipboard
data class ExecutionConfigArgs(val alias: Output<String>? = null, val config: Output<Map<String, String>>? = null, val executionId: Output<String>? = null, val realmId: Output<String>? = null) : ConvertibleToJava<ExecutionConfigArgs>

Allows for managing an authentication execution's configuration. If a particular authentication execution supports additional configuration (such as with the identity-provider-redirector execution), this can be managed with this resource.

Link copied to clipboard
object ExecutionConfigMapper : ResourceMapper<ExecutionConfig>
Link copied to clipboard
object ExecutionMapper : ResourceMapper<Execution>
Link copied to clipboard
Link copied to clipboard
class Flow : KotlinCustomResource

Allows for creating and managing an authentication flow within Keycloak. Authentication flows describe a sequence of actions that a user or service must perform in order to be authenticated to Keycloak. The authentication flow itself is a container for these actions, which are otherwise known as executions.

Link copied to clipboard
data class FlowArgs(val alias: Output<String>? = null, val description: Output<String>? = null, val providerId: Output<String>? = null, val realmId: Output<String>? = null) : ConvertibleToJava<FlowArgs>

Allows for creating and managing an authentication flow within Keycloak. Authentication flows describe a sequence of actions that a user or service must perform in order to be authenticated to Keycloak. The authentication flow itself is a container for these actions, which are otherwise known as executions.

Link copied to clipboard

Builder for FlowArgs.

Link copied to clipboard
object FlowMapper : ResourceMapper<Flow>
Link copied to clipboard

Builder for Flow.

Link copied to clipboard
class Subflow : KotlinCustomResource

Allows for creating and managing an authentication subflow within Keycloak. Like authentication flows, authentication subflows are containers for authentication executions. As its name implies, an authentication subflow is contained in an authentication flow.

Link copied to clipboard
data class SubflowArgs(val alias: Output<String>? = null, val authenticator: Output<String>? = null, val description: Output<String>? = null, val parentFlowAlias: Output<String>? = null, val priority: Output<Int>? = null, val providerId: Output<String>? = null, val realmId: Output<String>? = null, val requirement: Output<String>? = null) : ConvertibleToJava<SubflowArgs>

Allows for creating and managing an authentication subflow within Keycloak. Like authentication flows, authentication subflows are containers for authentication executions. As its name implies, an authentication subflow is contained in an authentication flow.

Link copied to clipboard
Link copied to clipboard
object SubflowMapper : ResourceMapper<Subflow>
Link copied to clipboard

Functions

Link copied to clipboard
suspend fun bindings(name: String, block: suspend BindingsResourceBuilder.() -> Unit): Bindings
Link copied to clipboard
suspend fun execution(name: String, block: suspend ExecutionResourceBuilder.() -> Unit): Execution
Link copied to clipboard
Link copied to clipboard
fun flow(name: String): Flow
suspend fun flow(name: String, block: suspend FlowResourceBuilder.() -> Unit): Flow
Link copied to clipboard
fun subflow(name: String): Subflow
suspend fun subflow(name: String, block: suspend SubflowResourceBuilder.() -> Unit): Subflow