Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Keycloak Provider
  3. API Docs
  4. ldap
  5. HardcodedGroupMapper
Keycloak v6.4.0 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-keycloak

keycloak.ldap.HardcodedGroupMapper

Explore with Pulumi AI

Keycloak v6.4.0 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-keycloak

Allows for creating and managing hardcoded group mappers for Keycloak users federated via LDAP.

The LDAP hardcoded group mapper will grant a specified Keycloak group to each Keycloak user linked with LDAP.

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 ldapUserFederation = new keycloak.ldap.UserFederation("ldap_user_federation", {
    name: "openldap",
    realmId: realm.id,
    usernameLdapAttribute: "cn",
    rdnLdapAttribute: "cn",
    uuidLdapAttribute: "entryDN",
    userObjectClasses: [
        "simpleSecurityObject",
        "organizationalRole",
    ],
    connectionUrl: "ldap://openldap",
    usersDn: "dc=example,dc=org",
    bindDn: "cn=admin,dc=example,dc=org",
    bindCredential: "admin",
});
const realmGroup = new keycloak.Group("realm_group", {
    realmId: realm.id,
    name: "my-group",
});
const assignGroupToUsers = new keycloak.ldap.HardcodedGroupMapper("assign_group_to_users", {
    realmId: realm.id,
    ldapUserFederationId: ldapUserFederation.id,
    name: "assign-group-to-users",
    group: realmGroup.name,
});
Copy
import pulumi
import pulumi_keycloak as keycloak

realm = keycloak.Realm("realm",
    realm="my-realm",
    enabled=True)
ldap_user_federation = keycloak.ldap.UserFederation("ldap_user_federation",
    name="openldap",
    realm_id=realm.id,
    username_ldap_attribute="cn",
    rdn_ldap_attribute="cn",
    uuid_ldap_attribute="entryDN",
    user_object_classes=[
        "simpleSecurityObject",
        "organizationalRole",
    ],
    connection_url="ldap://openldap",
    users_dn="dc=example,dc=org",
    bind_dn="cn=admin,dc=example,dc=org",
    bind_credential="admin")
realm_group = keycloak.Group("realm_group",
    realm_id=realm.id,
    name="my-group")
assign_group_to_users = keycloak.ldap.HardcodedGroupMapper("assign_group_to_users",
    realm_id=realm.id,
    ldap_user_federation_id=ldap_user_federation.id,
    name="assign-group-to-users",
    group=realm_group.name)
Copy
package main

import (
	"github.com/pulumi/pulumi-keycloak/sdk/v6/go/keycloak"
	"github.com/pulumi/pulumi-keycloak/sdk/v6/go/keycloak/ldap"
	"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
		}
		ldapUserFederation, err := ldap.NewUserFederation(ctx, "ldap_user_federation", &ldap.UserFederationArgs{
			Name:                  pulumi.String("openldap"),
			RealmId:               realm.ID(),
			UsernameLdapAttribute: pulumi.String("cn"),
			RdnLdapAttribute:      pulumi.String("cn"),
			UuidLdapAttribute:     pulumi.String("entryDN"),
			UserObjectClasses: pulumi.StringArray{
				pulumi.String("simpleSecurityObject"),
				pulumi.String("organizationalRole"),
			},
			ConnectionUrl:  pulumi.String("ldap://openldap"),
			UsersDn:        pulumi.String("dc=example,dc=org"),
			BindDn:         pulumi.String("cn=admin,dc=example,dc=org"),
			BindCredential: pulumi.String("admin"),
		})
		if err != nil {
			return err
		}
		realmGroup, err := keycloak.NewGroup(ctx, "realm_group", &keycloak.GroupArgs{
			RealmId: realm.ID(),
			Name:    pulumi.String("my-group"),
		})
		if err != nil {
			return err
		}
		_, err = ldap.NewHardcodedGroupMapper(ctx, "assign_group_to_users", &ldap.HardcodedGroupMapperArgs{
			RealmId:              realm.ID(),
			LdapUserFederationId: ldapUserFederation.ID(),
			Name:                 pulumi.String("assign-group-to-users"),
			Group:                realmGroup.Name,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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 ldapUserFederation = new Keycloak.Ldap.UserFederation("ldap_user_federation", new()
    {
        Name = "openldap",
        RealmId = realm.Id,
        UsernameLdapAttribute = "cn",
        RdnLdapAttribute = "cn",
        UuidLdapAttribute = "entryDN",
        UserObjectClasses = new[]
        {
            "simpleSecurityObject",
            "organizationalRole",
        },
        ConnectionUrl = "ldap://openldap",
        UsersDn = "dc=example,dc=org",
        BindDn = "cn=admin,dc=example,dc=org",
        BindCredential = "admin",
    });

    var realmGroup = new Keycloak.Group("realm_group", new()
    {
        RealmId = realm.Id,
        Name = "my-group",
    });

    var assignGroupToUsers = new Keycloak.Ldap.HardcodedGroupMapper("assign_group_to_users", new()
    {
        RealmId = realm.Id,
        LdapUserFederationId = ldapUserFederation.Id,
        Name = "assign-group-to-users",
        Group = realmGroup.Name,
    });

});
Copy
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.ldap.UserFederation;
import com.pulumi.keycloak.ldap.UserFederationArgs;
import com.pulumi.keycloak.Group;
import com.pulumi.keycloak.GroupArgs;
import com.pulumi.keycloak.ldap.HardcodedGroupMapper;
import com.pulumi.keycloak.ldap.HardcodedGroupMapperArgs;
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 ldapUserFederation = new UserFederation("ldapUserFederation", UserFederationArgs.builder()
            .name("openldap")
            .realmId(realm.id())
            .usernameLdapAttribute("cn")
            .rdnLdapAttribute("cn")
            .uuidLdapAttribute("entryDN")
            .userObjectClasses(            
                "simpleSecurityObject",
                "organizationalRole")
            .connectionUrl("ldap://openldap")
            .usersDn("dc=example,dc=org")
            .bindDn("cn=admin,dc=example,dc=org")
            .bindCredential("admin")
            .build());

        var realmGroup = new Group("realmGroup", GroupArgs.builder()
            .realmId(realm.id())
            .name("my-group")
            .build());

        var assignGroupToUsers = new HardcodedGroupMapper("assignGroupToUsers", HardcodedGroupMapperArgs.builder()
            .realmId(realm.id())
            .ldapUserFederationId(ldapUserFederation.id())
            .name("assign-group-to-users")
            .group(realmGroup.name())
            .build());

    }
}
Copy
resources:
  realm:
    type: keycloak:Realm
    properties:
      realm: my-realm
      enabled: true
  ldapUserFederation:
    type: keycloak:ldap:UserFederation
    name: ldap_user_federation
    properties:
      name: openldap
      realmId: ${realm.id}
      usernameLdapAttribute: cn
      rdnLdapAttribute: cn
      uuidLdapAttribute: entryDN
      userObjectClasses:
        - simpleSecurityObject
        - organizationalRole
      connectionUrl: ldap://openldap
      usersDn: dc=example,dc=org
      bindDn: cn=admin,dc=example,dc=org
      bindCredential: admin
  realmGroup:
    type: keycloak:Group
    name: realm_group
    properties:
      realmId: ${realm.id}
      name: my-group
  assignGroupToUsers:
    type: keycloak:ldap:HardcodedGroupMapper
    name: assign_group_to_users
    properties:
      realmId: ${realm.id}
      ldapUserFederationId: ${ldapUserFederation.id}
      name: assign-group-to-users
      group: ${realmGroup.name}
Copy

Create HardcodedGroupMapper Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new HardcodedGroupMapper(name: string, args: HardcodedGroupMapperArgs, opts?: CustomResourceOptions);
@overload
def HardcodedGroupMapper(resource_name: str,
                         args: HardcodedGroupMapperArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def HardcodedGroupMapper(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         group: Optional[str] = None,
                         ldap_user_federation_id: Optional[str] = None,
                         realm_id: Optional[str] = None,
                         name: Optional[str] = None)
func NewHardcodedGroupMapper(ctx *Context, name string, args HardcodedGroupMapperArgs, opts ...ResourceOption) (*HardcodedGroupMapper, error)
public HardcodedGroupMapper(string name, HardcodedGroupMapperArgs args, CustomResourceOptions? opts = null)
public HardcodedGroupMapper(String name, HardcodedGroupMapperArgs args)
public HardcodedGroupMapper(String name, HardcodedGroupMapperArgs args, CustomResourceOptions options)

type: keycloak:ldap:HardcodedGroupMapper
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. HardcodedGroupMapperArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. HardcodedGroupMapperArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. HardcodedGroupMapperArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. HardcodedGroupMapperArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. HardcodedGroupMapperArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var hardcodedGroupMapperResource = new Keycloak.Ldap.HardcodedGroupMapper("hardcodedGroupMapperResource", new()
{
    Group = "string",
    LdapUserFederationId = "string",
    RealmId = "string",
    Name = "string",
});
Copy
example, err := ldap.NewHardcodedGroupMapper(ctx, "hardcodedGroupMapperResource", &ldap.HardcodedGroupMapperArgs{
	Group:                pulumi.String("string"),
	LdapUserFederationId: pulumi.String("string"),
	RealmId:              pulumi.String("string"),
	Name:                 pulumi.String("string"),
})
Copy
var hardcodedGroupMapperResource = new HardcodedGroupMapper("hardcodedGroupMapperResource", HardcodedGroupMapperArgs.builder()
    .group("string")
    .ldapUserFederationId("string")
    .realmId("string")
    .name("string")
    .build());
Copy
hardcoded_group_mapper_resource = keycloak.ldap.HardcodedGroupMapper("hardcodedGroupMapperResource",
    group="string",
    ldap_user_federation_id="string",
    realm_id="string",
    name="string")
Copy
const hardcodedGroupMapperResource = new keycloak.ldap.HardcodedGroupMapper("hardcodedGroupMapperResource", {
    group: "string",
    ldapUserFederationId: "string",
    realmId: "string",
    name: "string",
});
Copy
type: keycloak:ldap:HardcodedGroupMapper
properties:
    group: string
    ldapUserFederationId: string
    name: string
    realmId: string
Copy

HardcodedGroupMapper Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The HardcodedGroupMapper resource accepts the following input properties:

Group
This property is required.
Changes to this property will trigger replacement.
string
The name of the group which should be assigned to the users.
LdapUserFederationId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the LDAP user federation provider to attach this mapper to.
RealmId
This property is required.
Changes to this property will trigger replacement.
string
The realm that this LDAP mapper will exist in.
Name string
Display name of this mapper when displayed in the console.
Group
This property is required.
Changes to this property will trigger replacement.
string
The name of the group which should be assigned to the users.
LdapUserFederationId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the LDAP user federation provider to attach this mapper to.
RealmId
This property is required.
Changes to this property will trigger replacement.
string
The realm that this LDAP mapper will exist in.
Name string
Display name of this mapper when displayed in the console.
group
This property is required.
Changes to this property will trigger replacement.
String
The name of the group which should be assigned to the users.
ldapUserFederationId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the LDAP user federation provider to attach this mapper to.
realmId
This property is required.
Changes to this property will trigger replacement.
String
The realm that this LDAP mapper will exist in.
name String
Display name of this mapper when displayed in the console.
group
This property is required.
Changes to this property will trigger replacement.
string
The name of the group which should be assigned to the users.
ldapUserFederationId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the LDAP user federation provider to attach this mapper to.
realmId
This property is required.
Changes to this property will trigger replacement.
string
The realm that this LDAP mapper will exist in.
name string
Display name of this mapper when displayed in the console.
group
This property is required.
Changes to this property will trigger replacement.
str
The name of the group which should be assigned to the users.
ldap_user_federation_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the LDAP user federation provider to attach this mapper to.
realm_id
This property is required.
Changes to this property will trigger replacement.
str
The realm that this LDAP mapper will exist in.
name str
Display name of this mapper when displayed in the console.
group
This property is required.
Changes to this property will trigger replacement.
String
The name of the group which should be assigned to the users.
ldapUserFederationId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the LDAP user federation provider to attach this mapper to.
realmId
This property is required.
Changes to this property will trigger replacement.
String
The realm that this LDAP mapper will exist in.
name String
Display name of this mapper when displayed in the console.

Outputs

All input properties are implicitly available as output properties. Additionally, the HardcodedGroupMapper resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing HardcodedGroupMapper Resource

Get an existing HardcodedGroupMapper resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: HardcodedGroupMapperState, opts?: CustomResourceOptions): HardcodedGroupMapper
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        group: Optional[str] = None,
        ldap_user_federation_id: Optional[str] = None,
        name: Optional[str] = None,
        realm_id: Optional[str] = None) -> HardcodedGroupMapper
func GetHardcodedGroupMapper(ctx *Context, name string, id IDInput, state *HardcodedGroupMapperState, opts ...ResourceOption) (*HardcodedGroupMapper, error)
public static HardcodedGroupMapper Get(string name, Input<string> id, HardcodedGroupMapperState? state, CustomResourceOptions? opts = null)
public static HardcodedGroupMapper get(String name, Output<String> id, HardcodedGroupMapperState state, CustomResourceOptions options)
resources:  _:    type: keycloak:ldap:HardcodedGroupMapper    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Group Changes to this property will trigger replacement. string
The name of the group which should be assigned to the users.
LdapUserFederationId Changes to this property will trigger replacement. string
The ID of the LDAP user federation provider to attach this mapper to.
Name string
Display name of this mapper when displayed in the console.
RealmId Changes to this property will trigger replacement. string
The realm that this LDAP mapper will exist in.
Group Changes to this property will trigger replacement. string
The name of the group which should be assigned to the users.
LdapUserFederationId Changes to this property will trigger replacement. string
The ID of the LDAP user federation provider to attach this mapper to.
Name string
Display name of this mapper when displayed in the console.
RealmId Changes to this property will trigger replacement. string
The realm that this LDAP mapper will exist in.
group Changes to this property will trigger replacement. String
The name of the group which should be assigned to the users.
ldapUserFederationId Changes to this property will trigger replacement. String
The ID of the LDAP user federation provider to attach this mapper to.
name String
Display name of this mapper when displayed in the console.
realmId Changes to this property will trigger replacement. String
The realm that this LDAP mapper will exist in.
group Changes to this property will trigger replacement. string
The name of the group which should be assigned to the users.
ldapUserFederationId Changes to this property will trigger replacement. string
The ID of the LDAP user federation provider to attach this mapper to.
name string
Display name of this mapper when displayed in the console.
realmId Changes to this property will trigger replacement. string
The realm that this LDAP mapper will exist in.
group Changes to this property will trigger replacement. str
The name of the group which should be assigned to the users.
ldap_user_federation_id Changes to this property will trigger replacement. str
The ID of the LDAP user federation provider to attach this mapper to.
name str
Display name of this mapper when displayed in the console.
realm_id Changes to this property will trigger replacement. str
The realm that this LDAP mapper will exist in.
group Changes to this property will trigger replacement. String
The name of the group which should be assigned to the users.
ldapUserFederationId Changes to this property will trigger replacement. String
The ID of the LDAP user federation provider to attach this mapper to.
name String
Display name of this mapper when displayed in the console.
realmId Changes to this property will trigger replacement. String
The realm that this LDAP mapper will exist in.

Import

LDAP mappers can be imported using the format {{realm_id}}/{{ldap_user_federation_id}}/{{ldap_mapper_id}}.

The ID of the LDAP user federation provider and the mapper can be found within the Keycloak GUI, and they are typically GUIDs.

Example:

bash

$ pulumi import keycloak:ldap/hardcodedGroupMapper:HardcodedGroupMapper assign_group_to_users my-realm/af2a6ca3-e4d7-49c3-b08b-1b3c70b4b860/3d923ece-1a91-4bf7-adaf-3b82f2a12b67
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Keycloak pulumi/pulumi-keycloak
License
Apache-2.0
Notes
This Pulumi package is based on the keycloak Terraform Provider.
Keycloak v6.4.0 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-keycloak