Keycloak

v4.11.0 published on Thursday, Aug 4, 2022 by Pulumi

UserAttributeMapper

Allows for creating and managing user attribute mappers for Keycloak users federated via LDAP.

The LDAP user attribute mapper can be used to map a single LDAP attribute to an attribute on the Keycloak user model.

Example Usage

using Pulumi;
using Keycloak = Pulumi.Keycloak;

class MyStack : Stack
{
    public MyStack()
    {
        var realm = new Keycloak.Realm("realm", new Keycloak.RealmArgs
        {
            RealmName = "my-realm",
            Enabled = true,
        });
        var ldapUserFederation = new Keycloak.Ldap.UserFederation("ldapUserFederation", new Keycloak.Ldap.UserFederationArgs
        {
            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",
        });
        var ldapUserAttributeMapper = new Keycloak.Ldap.UserAttributeMapper("ldapUserAttributeMapper", new Keycloak.Ldap.UserAttributeMapperArgs
        {
            RealmId = realm.Id,
            LdapUserFederationId = ldapUserFederation.Id,
            UserModelAttribute = "foo",
            LdapAttribute = "bar",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-keycloak/sdk/v4/go/keycloak"
	"github.com/pulumi/pulumi-keycloak/sdk/v4/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, "ldapUserFederation", &ldap.UserFederationArgs{
			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
		}
		_, err = ldap.NewUserAttributeMapper(ctx, "ldapUserAttributeMapper", &ldap.UserAttributeMapperArgs{
			RealmId:              realm.ID(),
			LdapUserFederationId: ldapUserFederation.ID(),
			UserModelAttribute:   pulumi.String("foo"),
			LdapAttribute:        pulumi.String("bar"),
		})
		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.ldap.UserFederation;
import com.pulumi.keycloak.ldap.UserFederationArgs;
import com.pulumi.keycloak.ldap.UserAttributeMapper;
import com.pulumi.keycloak.ldap.UserAttributeMapperArgs;
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()        
            .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 ldapUserAttributeMapper = new UserAttributeMapper("ldapUserAttributeMapper", UserAttributeMapperArgs.builder()        
            .realmId(realm.id())
            .ldapUserFederationId(ldapUserFederation.id())
            .userModelAttribute("foo")
            .ldapAttribute("bar")
            .build());

    }
}
import pulumi
import pulumi_keycloak as keycloak

realm = keycloak.Realm("realm",
    realm="my-realm",
    enabled=True)
ldap_user_federation = keycloak.ldap.UserFederation("ldapUserFederation",
    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")
ldap_user_attribute_mapper = keycloak.ldap.UserAttributeMapper("ldapUserAttributeMapper",
    realm_id=realm.id,
    ldap_user_federation_id=ldap_user_federation.id,
    user_model_attribute="foo",
    ldap_attribute="bar")
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("ldapUserFederation", {
    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 ldapUserAttributeMapper = new keycloak.ldap.UserAttributeMapper("ldapUserAttributeMapper", {
    realmId: realm.id,
    ldapUserFederationId: ldapUserFederation.id,
    userModelAttribute: "foo",
    ldapAttribute: "bar",
});
resources:
  realm:
    type: keycloak:Realm
    properties:
      realm: my-realm
      enabled: true
  ldapUserFederation:
    type: keycloak:ldap:UserFederation
    properties:
      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
  ldapUserAttributeMapper:
    type: keycloak:ldap:UserAttributeMapper
    properties:
      realmId: ${realm.id}
      ldapUserFederationId: ${ldapUserFederation.id}
      userModelAttribute: foo
      ldapAttribute: bar

Create UserAttributeMapper Resource

new UserAttributeMapper(name: string, args: UserAttributeMapperArgs, opts?: CustomResourceOptions);
@overload
def UserAttributeMapper(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        always_read_value_from_ldap: Optional[bool] = None,
                        is_mandatory_in_ldap: Optional[bool] = None,
                        ldap_attribute: Optional[str] = None,
                        ldap_user_federation_id: Optional[str] = None,
                        name: Optional[str] = None,
                        read_only: Optional[bool] = None,
                        realm_id: Optional[str] = None,
                        user_model_attribute: Optional[str] = None)
@overload
def UserAttributeMapper(resource_name: str,
                        args: UserAttributeMapperArgs,
                        opts: Optional[ResourceOptions] = None)
func NewUserAttributeMapper(ctx *Context, name string, args UserAttributeMapperArgs, opts ...ResourceOption) (*UserAttributeMapper, error)
public UserAttributeMapper(string name, UserAttributeMapperArgs args, CustomResourceOptions? opts = null)
public UserAttributeMapper(String name, UserAttributeMapperArgs args)
public UserAttributeMapper(String name, UserAttributeMapperArgs args, CustomResourceOptions options)
type: keycloak:ldap:UserAttributeMapper
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

UserAttributeMapper Resource Properties

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

Inputs

The UserAttributeMapper resource accepts the following input properties:

LdapAttribute string

Name of the mapped attribute on the LDAP object.

LdapUserFederationId string

The ID of the LDAP user federation provider to attach this mapper to.

RealmId string

The realm that this LDAP mapper will exist in.

UserModelAttribute string

Name of the user property or attribute you want to map the LDAP attribute into.

AlwaysReadValueFromLdap bool

When true, the value fetched from LDAP will override the value stored in Keycloak. Defaults to false.

IsMandatoryInLdap bool

When true, this attribute must exist in LDAP. Defaults to false.

Name string

Display name of this mapper when displayed in the console.

ReadOnly bool

When true, this attribute is not saved back to LDAP when the user attribute is updated in Keycloak. Defaults to false.

LdapAttribute string

Name of the mapped attribute on the LDAP object.

LdapUserFederationId string

The ID of the LDAP user federation provider to attach this mapper to.

RealmId string

The realm that this LDAP mapper will exist in.

UserModelAttribute string

Name of the user property or attribute you want to map the LDAP attribute into.

AlwaysReadValueFromLdap bool

When true, the value fetched from LDAP will override the value stored in Keycloak. Defaults to false.

IsMandatoryInLdap bool

When true, this attribute must exist in LDAP. Defaults to false.

Name string

Display name of this mapper when displayed in the console.

ReadOnly bool

When true, this attribute is not saved back to LDAP when the user attribute is updated in Keycloak. Defaults to false.

ldapAttribute String

Name of the mapped attribute on the LDAP object.

ldapUserFederationId String

The ID of the LDAP user federation provider to attach this mapper to.

realmId String

The realm that this LDAP mapper will exist in.

userModelAttribute String

Name of the user property or attribute you want to map the LDAP attribute into.

alwaysReadValueFromLdap Boolean

When true, the value fetched from LDAP will override the value stored in Keycloak. Defaults to false.

isMandatoryInLdap Boolean

When true, this attribute must exist in LDAP. Defaults to false.

name String

Display name of this mapper when displayed in the console.

readOnly Boolean

When true, this attribute is not saved back to LDAP when the user attribute is updated in Keycloak. Defaults to false.

ldapAttribute string

Name of the mapped attribute on the LDAP object.

ldapUserFederationId string

The ID of the LDAP user federation provider to attach this mapper to.

realmId string

The realm that this LDAP mapper will exist in.

userModelAttribute string

Name of the user property or attribute you want to map the LDAP attribute into.

alwaysReadValueFromLdap boolean

When true, the value fetched from LDAP will override the value stored in Keycloak. Defaults to false.

isMandatoryInLdap boolean

When true, this attribute must exist in LDAP. Defaults to false.

name string

Display name of this mapper when displayed in the console.

readOnly boolean

When true, this attribute is not saved back to LDAP when the user attribute is updated in Keycloak. Defaults to false.

ldap_attribute str

Name of the mapped attribute on the LDAP object.

ldap_user_federation_id str

The ID of the LDAP user federation provider to attach this mapper to.

realm_id str

The realm that this LDAP mapper will exist in.

user_model_attribute str

Name of the user property or attribute you want to map the LDAP attribute into.

always_read_value_from_ldap bool

When true, the value fetched from LDAP will override the value stored in Keycloak. Defaults to false.

is_mandatory_in_ldap bool

When true, this attribute must exist in LDAP. Defaults to false.

name str

Display name of this mapper when displayed in the console.

read_only bool

When true, this attribute is not saved back to LDAP when the user attribute is updated in Keycloak. Defaults to false.

ldapAttribute String

Name of the mapped attribute on the LDAP object.

ldapUserFederationId String

The ID of the LDAP user federation provider to attach this mapper to.

realmId String

The realm that this LDAP mapper will exist in.

userModelAttribute String

Name of the user property or attribute you want to map the LDAP attribute into.

alwaysReadValueFromLdap Boolean

When true, the value fetched from LDAP will override the value stored in Keycloak. Defaults to false.

isMandatoryInLdap Boolean

When true, this attribute must exist in LDAP. Defaults to false.

name String

Display name of this mapper when displayed in the console.

readOnly Boolean

When true, this attribute is not saved back to LDAP when the user attribute is updated in Keycloak. Defaults to false.

Outputs

All input properties are implicitly available as output properties. Additionally, the UserAttributeMapper 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 UserAttributeMapper Resource

Get an existing UserAttributeMapper 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?: UserAttributeMapperState, opts?: CustomResourceOptions): UserAttributeMapper
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        always_read_value_from_ldap: Optional[bool] = None,
        is_mandatory_in_ldap: Optional[bool] = None,
        ldap_attribute: Optional[str] = None,
        ldap_user_federation_id: Optional[str] = None,
        name: Optional[str] = None,
        read_only: Optional[bool] = None,
        realm_id: Optional[str] = None,
        user_model_attribute: Optional[str] = None) -> UserAttributeMapper
func GetUserAttributeMapper(ctx *Context, name string, id IDInput, state *UserAttributeMapperState, opts ...ResourceOption) (*UserAttributeMapper, error)
public static UserAttributeMapper Get(string name, Input<string> id, UserAttributeMapperState? state, CustomResourceOptions? opts = null)
public static UserAttributeMapper get(String name, Output<String> id, UserAttributeMapperState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
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:
AlwaysReadValueFromLdap bool

When true, the value fetched from LDAP will override the value stored in Keycloak. Defaults to false.

IsMandatoryInLdap bool

When true, this attribute must exist in LDAP. Defaults to false.

LdapAttribute string

Name of the mapped attribute on the LDAP object.

LdapUserFederationId 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.

ReadOnly bool

When true, this attribute is not saved back to LDAP when the user attribute is updated in Keycloak. Defaults to false.

RealmId string

The realm that this LDAP mapper will exist in.

UserModelAttribute string

Name of the user property or attribute you want to map the LDAP attribute into.

AlwaysReadValueFromLdap bool

When true, the value fetched from LDAP will override the value stored in Keycloak. Defaults to false.

IsMandatoryInLdap bool

When true, this attribute must exist in LDAP. Defaults to false.

LdapAttribute string

Name of the mapped attribute on the LDAP object.

LdapUserFederationId 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.

ReadOnly bool

When true, this attribute is not saved back to LDAP when the user attribute is updated in Keycloak. Defaults to false.

RealmId string

The realm that this LDAP mapper will exist in.

UserModelAttribute string

Name of the user property or attribute you want to map the LDAP attribute into.

alwaysReadValueFromLdap Boolean

When true, the value fetched from LDAP will override the value stored in Keycloak. Defaults to false.

isMandatoryInLdap Boolean

When true, this attribute must exist in LDAP. Defaults to false.

ldapAttribute String

Name of the mapped attribute on the LDAP object.

ldapUserFederationId 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.

readOnly Boolean

When true, this attribute is not saved back to LDAP when the user attribute is updated in Keycloak. Defaults to false.

realmId String

The realm that this LDAP mapper will exist in.

userModelAttribute String

Name of the user property or attribute you want to map the LDAP attribute into.

alwaysReadValueFromLdap boolean

When true, the value fetched from LDAP will override the value stored in Keycloak. Defaults to false.

isMandatoryInLdap boolean

When true, this attribute must exist in LDAP. Defaults to false.

ldapAttribute string

Name of the mapped attribute on the LDAP object.

ldapUserFederationId 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.

readOnly boolean

When true, this attribute is not saved back to LDAP when the user attribute is updated in Keycloak. Defaults to false.

realmId string

The realm that this LDAP mapper will exist in.

userModelAttribute string

Name of the user property or attribute you want to map the LDAP attribute into.

always_read_value_from_ldap bool

When true, the value fetched from LDAP will override the value stored in Keycloak. Defaults to false.

is_mandatory_in_ldap bool

When true, this attribute must exist in LDAP. Defaults to false.

ldap_attribute str

Name of the mapped attribute on the LDAP object.

ldap_user_federation_id 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.

read_only bool

When true, this attribute is not saved back to LDAP when the user attribute is updated in Keycloak. Defaults to false.

realm_id str

The realm that this LDAP mapper will exist in.

user_model_attribute str

Name of the user property or attribute you want to map the LDAP attribute into.

alwaysReadValueFromLdap Boolean

When true, the value fetched from LDAP will override the value stored in Keycloak. Defaults to false.

isMandatoryInLdap Boolean

When true, this attribute must exist in LDAP. Defaults to false.

ldapAttribute String

Name of the mapped attribute on the LDAP object.

ldapUserFederationId 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.

readOnly Boolean

When true, this attribute is not saved back to LDAP when the user attribute is updated in Keycloak. Defaults to false.

realmId String

The realm that this LDAP mapper will exist in.

userModelAttribute String

Name of the user property or attribute you want to map the LDAP attribute into.

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. Examplebash

 $ pulumi import keycloak:ldap/userAttributeMapper:UserAttributeMapper ldap_user_attribute_mapper my-realm/af2a6ca3-e4d7-49c3-b08b-1b3c70b4b860/3d923ece-1a91-4bf7-adaf-3b82f2a12b67

Package Details

Repository
https://github.com/pulumi/pulumi-keycloak
License
Apache-2.0
Notes

This Pulumi package is based on the keycloak Terraform Provider.