RequiredAction

class RequiredAction : KotlinCustomResource

Allows for creating and managing required actions within Keycloak. Required actions specify actions required before the first login of all new users.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as keycloak from "@pulumi/keycloak";
const realm = new keycloak.Realm("realm", {
realm: "my-realm",
enabled: true,
});
const requiredAction = new keycloak.RequiredAction("required_action", {
realmId: realm.realm,
alias: "webauthn-register",
enabled: true,
name: "Webauthn Register",
});
import pulumi
import pulumi_keycloak as keycloak
realm = keycloak.Realm("realm",
realm="my-realm",
enabled=True)
required_action = keycloak.RequiredAction("required_action",
realm_id=realm.realm,
alias="webauthn-register",
enabled=True,
name="Webauthn Register")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Keycloak = Pulumi.Keycloak;
return await Deployment.RunAsync(() =>
{
var realm = new Keycloak.Realm("realm", new()
{
RealmName = "my-realm",
Enabled = true,
});
var requiredAction = new Keycloak.RequiredAction("required_action", new()
{
RealmId = realm.RealmName,
Alias = "webauthn-register",
Enabled = true,
Name = "Webauthn Register",
});
});
package main
import (
"github.com/pulumi/pulumi-keycloak/sdk/v5/go/keycloak"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
realm, err := keycloak.NewRealm(ctx, "realm", &keycloak.RealmArgs{
Realm: pulumi.String("my-realm"),
Enabled: pulumi.Bool(true),
})
if err != nil {
return err
}
_, err = keycloak.NewRequiredAction(ctx, "required_action", &keycloak.RequiredActionArgs{
RealmId: realm.Realm,
Alias: pulumi.String("webauthn-register"),
Enabled: pulumi.Bool(true),
Name: pulumi.String("Webauthn Register"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.keycloak.Realm;
import com.pulumi.keycloak.RealmArgs;
import com.pulumi.keycloak.RequiredAction;
import com.pulumi.keycloak.RequiredActionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var realm = new Realm("realm", RealmArgs.builder()
.realm("my-realm")
.enabled(true)
.build());
var requiredAction = new RequiredAction("requiredAction", RequiredActionArgs.builder()
.realmId(realm.realm())
.alias("webauthn-register")
.enabled(true)
.name("Webauthn Register")
.build());
}
}
resources:
realm:
type: keycloak:Realm
properties:
realm: my-realm
enabled: true
requiredAction:
type: keycloak:RequiredAction
name: required_action
properties:
realmId: ${realm.realm}
alias: webauthn-register
enabled: true
name: Webauthn Register

Import

Authentication executions can be imported using the formats: {{realm}}/{{alias}}. Example: bash

$ pulumi import keycloak:index/requiredAction:RequiredAction required_action my-realm/my-default-action-alias

Properties

Link copied to clipboard
val alias: Output<String>

The alias of the action to attach as a required action.

Link copied to clipboard
val defaultAction: Output<Boolean>?

When true, the required action is set as the default action for new users. Defaults to false.

Link copied to clipboard
val enabled: Output<Boolean>?

When false, the required action is not enabled for new users. Defaults to false.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val name: Output<String>

The name of the required action.

Link copied to clipboard
val priority: Output<Int>

The priority of the required action.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val realmId: Output<String>

The realm the required action exists in.

Link copied to clipboard
val urn: Output<String>