pulumi-keycloak-kotlin/com.pulumi.keycloak.kotlin/UserArgs

UserArgs

data class UserArgs(val attributes: Output<Map<String, String>>? = null, val email: Output<String>? = null, val emailVerified: Output<Boolean>? = null, val enabled: Output<Boolean>? = null, val federatedIdentities: Output<List<UserFederatedIdentityArgs>>? = null, val firstName: Output<String>? = null, val import: Output<Boolean>? = null, val initialPassword: Output<UserInitialPasswordArgs>? = null, val lastName: Output<String>? = null, val realmId: Output<String>? = null, val requiredActions: Output<List<String>>? = null, val username: Output<String>? = null) : ConvertibleToJava<UserArgs>

Allows for creating and managing Users within Keycloak. This resource was created primarily to enable the acceptance tests for the keycloak.Group resource. Creating users within Keycloak is not recommended. Instead, users should be federated from external sources by configuring user federation providers or identity providers.

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 user = new keycloak.User("user", {
    realmId: realm.id,
    username: "bob",
    enabled: true,
    email: "bob@domain.com",
    firstName: "Bob",
    lastName: "Bobson",
});
const userWithInitialPassword = new keycloak.User("user_with_initial_password", {
    realmId: realm.id,
    username: "alice",
    enabled: true,
    email: "alice@domain.com",
    firstName: "Alice",
    lastName: "Aliceberg",
    attributes: {
        foo: "bar",
        multivalue: "value1##value2",
    },
    initialPassword: {
        value: "some password",
        temporary: true,
    },
});

import pulumi
import pulumi_keycloak as keycloak
realm = keycloak.Realm("realm",
    realm="my-realm",
    enabled=True)
user = keycloak.User("user",
    realm_id=realm.id,
    username="bob",
    enabled=True,
    email="bob@domain.com",
    first_name="Bob",
    last_name="Bobson")
user_with_initial_password = keycloak.User("user_with_initial_password",
    realm_id=realm.id,
    username="alice",
    enabled=True,
    email="alice@domain.com",
    first_name="Alice",
    last_name="Aliceberg",
    attributes={
        "foo": "bar",
        "multivalue": "value1##value2",
    },
    initial_password={
        "value": "some password",
        "temporary": True,
    })

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 user = new Keycloak.User("user", new()
    {
        RealmId = realm.Id,
        Username = "bob",
        Enabled = true,
        Email = "bob@domain.com",
        FirstName = "Bob",
        LastName = "Bobson",
    });
    var userWithInitialPassword = new Keycloak.User("user_with_initial_password", new()
    {
        RealmId = realm.Id,
        Username = "alice",
        Enabled = true,
        Email = "alice@domain.com",
        FirstName = "Alice",
        LastName = "Aliceberg",
        Attributes =
        {
            { "foo", "bar" },
            { "multivalue", "value1##value2" },
        },
        InitialPassword = new Keycloak.Inputs.UserInitialPasswordArgs
        {
            Value = "some password",
            Temporary = true,
        },
    });
});

package main
import (
	"github.com/pulumi/pulumi-keycloak/sdk/v6/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.NewUser(ctx, "user", &keycloak.UserArgs{
			RealmId:   realm.ID(),
			Username:  pulumi.String("bob"),
			Enabled:   pulumi.Bool(true),
			Email:     pulumi.String("bob@domain.com"),
			FirstName: pulumi.String("Bob"),
			LastName:  pulumi.String("Bobson"),
		})
		if err != nil {
			return err
		}
		_, err = keycloak.NewUser(ctx, "user_with_initial_password", &keycloak.UserArgs{
			RealmId:   realm.ID(),
			Username:  pulumi.String("alice"),
			Enabled:   pulumi.Bool(true),
			Email:     pulumi.String("alice@domain.com"),
			FirstName: pulumi.String("Alice"),
			LastName:  pulumi.String("Aliceberg"),
			Attributes: pulumi.StringMap{
				"foo":        pulumi.String("bar"),
				"multivalue": pulumi.String("value1##value2"),
			},
			InitialPassword: &keycloak.UserInitialPasswordArgs{
				Value:     pulumi.String("some password"),
				Temporary: pulumi.Bool(true),
			},
		})
		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.User;
import com.pulumi.keycloak.UserArgs;
import com.pulumi.keycloak.inputs.UserInitialPasswordArgs;
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 user = new User("user", UserArgs.builder()
            .realmId(realm.id())
            .username("bob")
            .enabled(true)
            .email("bob@domain.com")
            .firstName("Bob")
            .lastName("Bobson")
            .build());
        var userWithInitialPassword = new User("userWithInitialPassword", UserArgs.builder()
            .realmId(realm.id())
            .username("alice")
            .enabled(true)
            .email("alice@domain.com")
            .firstName("Alice")
            .lastName("Aliceberg")
            .attributes(Map.ofEntries(
                Map.entry("foo", "bar"),
                Map.entry("multivalue", "value1##value2")
            ))
            .initialPassword(UserInitialPasswordArgs.builder()
                .value("some password")
                .temporary(true)
                .build())
            .build());
    }
}

resources:
  realm:
    type: keycloak:Realm
    properties:
      realm: my-realm
      enabled: true
  user:
    type: keycloak:User
    properties:
      realmId: ${realm.id}
      username: bob
      enabled: true
      email: bob@domain.com
      firstName: Bob
      lastName: Bobson
  userWithInitialPassword:
    type: keycloak:User
    name: user_with_initial_password
    properties:
      realmId: ${realm.id}
      username: alice
      enabled: true
      email: alice@domain.com
      firstName: Alice
      lastName: Aliceberg
      attributes:
        foo: bar
        multivalue: value1##value2
      initialPassword:
        value: some password
        temporary: true

Import

Users can be imported using the format {{realm_id}}/{{user_id}}, where user_id is the unique ID that Keycloak assigns to the user upon creation. This value can be found in the GUI when editing the user. Example: bash

$ pulumi import keycloak:index/user:User user my-realm/60c3f971-b1d3-4b3a-9035-d16d7540a5e4

Constructors

UserArgs

constructor(attributes: Output<Map<String, String>>? = null, email: Output<String>? = null, emailVerified: Output<Boolean>? = null, enabled: Output<Boolean>? = null, federatedIdentities: Output<List<UserFederatedIdentityArgs>>? = null, firstName: Output<String>? = null, import: Output<Boolean>? = null, initialPassword: Output<UserInitialPasswordArgs>? = null, lastName: Output<String>? = null, realmId: Output<String>? = null, requiredActions: Output<List<String>>? = null, username: Output<String>? = null)

Properties

attributes

val attributes: Output<Map<String, String>>? = null

A map representing attributes for the user. In order to add multivalue attributes, use ## to seperate the values. Max length for each value is 255 chars

val email: Output<String>? = null

The user's email.

emailVerified

val emailVerified: Output<Boolean>? = null

Whether the email address was validated or not. Default to false.

enabled

val enabled: Output<Boolean>? = null

When false, this user cannot log in. Defaults to true.

federatedIdentities

val federatedIdentities: Output<List<UserFederatedIdentityArgs>>? = null

When specified, the user will be linked to a federated identity provider. Refer to the federated user example for more details.

firstName

val firstName: Output<String>? = null

The user's first name.

import

val import: Output<Boolean>? = null

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.