Keycloak

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

FullNameMapper

Allows for creating and managing full name mappers for Keycloak users federated via LDAP.

The LDAP full name mapper can map a user’s full name from an LDAP attribute to the first and last name attributes of a Keycloak user.

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 ldapFullNameMapper = new Keycloak.Ldap.FullNameMapper("ldapFullNameMapper", new Keycloak.Ldap.FullNameMapperArgs
        {
            RealmId = realm.Id,
            LdapUserFederationId = ldapUserFederation.Id,
            LdapFullNameAttribute = "cn",
        });
    }

}
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.NewFullNameMapper(ctx, "ldapFullNameMapper", &ldap.FullNameMapperArgs{
			RealmId:               realm.ID(),
			LdapUserFederationId:  ldapUserFederation.ID(),
			LdapFullNameAttribute: pulumi.String("cn"),
		})
		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.FullNameMapper;
import com.pulumi.keycloak.ldap.FullNameMapperArgs;
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 ldapFullNameMapper = new FullNameMapper("ldapFullNameMapper", FullNameMapperArgs.builder()        
            .realmId(realm.id())
            .ldapUserFederationId(ldapUserFederation.id())
            .ldapFullNameAttribute("cn")
            .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_full_name_mapper = keycloak.ldap.FullNameMapper("ldapFullNameMapper",
    realm_id=realm.id,
    ldap_user_federation_id=ldap_user_federation.id,
    ldap_full_name_attribute="cn")
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 ldapFullNameMapper = new keycloak.ldap.FullNameMapper("ldapFullNameMapper", {
    realmId: realm.id,
    ldapUserFederationId: ldapUserFederation.id,
    ldapFullNameAttribute: "cn",
});
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
  ldapFullNameMapper:
    type: keycloak:ldap:FullNameMapper
    properties:
      realmId: ${realm.id}
      ldapUserFederationId: ${ldapUserFederation.id}
      ldapFullNameAttribute: cn

Create FullNameMapper Resource

new FullNameMapper(name: string, args: FullNameMapperArgs, opts?: CustomResourceOptions);
@overload
def FullNameMapper(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   ldap_full_name_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,
                   write_only: Optional[bool] = None)
@overload
def FullNameMapper(resource_name: str,
                   args: FullNameMapperArgs,
                   opts: Optional[ResourceOptions] = None)
func NewFullNameMapper(ctx *Context, name string, args FullNameMapperArgs, opts ...ResourceOption) (*FullNameMapper, error)
public FullNameMapper(string name, FullNameMapperArgs args, CustomResourceOptions? opts = null)
public FullNameMapper(String name, FullNameMapperArgs args)
public FullNameMapper(String name, FullNameMapperArgs args, CustomResourceOptions options)
type: keycloak:ldap:FullNameMapper
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args FullNameMapperArgs
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 FullNameMapperArgs
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 FullNameMapperArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args FullNameMapperArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args FullNameMapperArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

FullNameMapper 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 FullNameMapper resource accepts the following input properties:

LdapFullNameAttribute string

The name of the LDAP attribute containing the user's full name.

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.

Name string

Display name of this mapper when displayed in the console.

ReadOnly bool

When true, updates to a user within Keycloak will not be written back to LDAP. Defaults to false.

WriteOnly bool

When true, this mapper will only be used to write updates to LDAP. Defaults to false.

LdapFullNameAttribute string

The name of the LDAP attribute containing the user's full name.

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.

Name string

Display name of this mapper when displayed in the console.

ReadOnly bool

When true, updates to a user within Keycloak will not be written back to LDAP. Defaults to false.

WriteOnly bool

When true, this mapper will only be used to write updates to LDAP. Defaults to false.

ldapFullNameAttribute String

The name of the LDAP attribute containing the user's full name.

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.

name String

Display name of this mapper when displayed in the console.

readOnly Boolean

When true, updates to a user within Keycloak will not be written back to LDAP. Defaults to false.

writeOnly Boolean

When true, this mapper will only be used to write updates to LDAP. Defaults to false.

ldapFullNameAttribute string

The name of the LDAP attribute containing the user's full name.

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.

name string

Display name of this mapper when displayed in the console.

readOnly boolean

When true, updates to a user within Keycloak will not be written back to LDAP. Defaults to false.

writeOnly boolean

When true, this mapper will only be used to write updates to LDAP. Defaults to false.

ldap_full_name_attribute str

The name of the LDAP attribute containing the user's full name.

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.

name str

Display name of this mapper when displayed in the console.

read_only bool

When true, updates to a user within Keycloak will not be written back to LDAP. Defaults to false.

write_only bool

When true, this mapper will only be used to write updates to LDAP. Defaults to false.

ldapFullNameAttribute String

The name of the LDAP attribute containing the user's full name.

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.

name String

Display name of this mapper when displayed in the console.

readOnly Boolean

When true, updates to a user within Keycloak will not be written back to LDAP. Defaults to false.

writeOnly Boolean

When true, this mapper will only be used to write updates to LDAP. Defaults to false.

Outputs

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

Get an existing FullNameMapper 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?: FullNameMapperState, opts?: CustomResourceOptions): FullNameMapper
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ldap_full_name_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,
        write_only: Optional[bool] = None) -> FullNameMapper
func GetFullNameMapper(ctx *Context, name string, id IDInput, state *FullNameMapperState, opts ...ResourceOption) (*FullNameMapper, error)
public static FullNameMapper Get(string name, Input<string> id, FullNameMapperState? state, CustomResourceOptions? opts = null)
public static FullNameMapper get(String name, Output<String> id, FullNameMapperState 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:
LdapFullNameAttribute string

The name of the LDAP attribute containing the user's full name.

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, updates to a user within Keycloak will not be written back to LDAP. Defaults to false.

RealmId string

The realm that this LDAP mapper will exist in.

WriteOnly bool

When true, this mapper will only be used to write updates to LDAP. Defaults to false.

LdapFullNameAttribute string

The name of the LDAP attribute containing the user's full name.

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, updates to a user within Keycloak will not be written back to LDAP. Defaults to false.

RealmId string

The realm that this LDAP mapper will exist in.

WriteOnly bool

When true, this mapper will only be used to write updates to LDAP. Defaults to false.

ldapFullNameAttribute String

The name of the LDAP attribute containing the user's full name.

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, updates to a user within Keycloak will not be written back to LDAP. Defaults to false.

realmId String

The realm that this LDAP mapper will exist in.

writeOnly Boolean

When true, this mapper will only be used to write updates to LDAP. Defaults to false.

ldapFullNameAttribute string

The name of the LDAP attribute containing the user's full name.

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, updates to a user within Keycloak will not be written back to LDAP. Defaults to false.

realmId string

The realm that this LDAP mapper will exist in.

writeOnly boolean

When true, this mapper will only be used to write updates to LDAP. Defaults to false.

ldap_full_name_attribute str

The name of the LDAP attribute containing the user's full name.

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, updates to a user within Keycloak will not be written back to LDAP. Defaults to false.

realm_id str

The realm that this LDAP mapper will exist in.

write_only bool

When true, this mapper will only be used to write updates to LDAP. Defaults to false.

ldapFullNameAttribute String

The name of the LDAP attribute containing the user's full name.

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, updates to a user within Keycloak will not be written back to LDAP. Defaults to false.

realmId String

The realm that this LDAP mapper will exist in.

writeOnly Boolean

When true, this mapper will only be used to write updates to LDAP. Defaults to false.

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/fullNameMapper:FullNameMapper ldap_full_name_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.