Class FullNameMapper

# keycloak.ldap.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
    {
        Enabled = true,
        Realm = "test",
    });
    var ldapUserFederation = new Keycloak.Ldap.UserFederation("ldapUserFederation", new Keycloak.Ldap.UserFederationArgs
    {
        BindCredential = "admin",
        BindDn = "cn=admin,dc=example,dc=org",
        ConnectionUrl = "ldap://openldap",
        RdnLdapAttribute = "cn",
        RealmId = realm.Id,
        UserObjectClasses = 
        {
            "simpleSecurityObject",
            "organizationalRole",
        },
        UsernameLdapAttribute = "cn",
        UsersDn = "dc=example,dc=org",
        UuidLdapAttribute = "entryDN",
    });
    var ldapFullNameMapper = new Keycloak.Ldap.FullNameMapper("ldapFullNameMapper", new Keycloak.Ldap.FullNameMapperArgs
    {
        LdapFullNameAttribute = "cn",
        LdapUserFederationId = ldapUserFederation.Id,
        RealmId = realm.Id,
    });
}

}

Argument Reference

The following arguments are supported:

• realm_id - (Required) The realm that this LDAP mapper will exist in.
• ldap_user_federation_id - (Required) The ID of the LDAP user federation provider to attach this mapper to.
• name - (Required) Display name of this mapper when displayed in the console.
• ldap_full_name_attribute - (Required) The name of the LDAP attribute containing the user's full name.
• read_only - (Optional) When true, updates to a user within Keycloak will not be written back to LDAP. Defaults to false.
• write_only - (Optional) When true, this mapper will only be used to write updates to LDAP. Defaults to false.

Inheritance

System.Object

Resource

CustomResource

FullNameMapper

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Keycloak.Ldap

Assembly: Pulumi.Keycloak.dll

Syntax

public class FullNameMapper : CustomResource

Constructors

FullNameMapper(String, FullNameMapperArgs, CustomResourceOptions)

Create a FullNameMapper resource with the given unique name, arguments, and options.

Declaration

public FullNameMapper(string name, FullNameMapperArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
FullNameMapperArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

LdapFullNameAttribute

Declaration

public Output<string> LdapFullNameAttribute { get; }

Property Value

Type	Description
Output<System.String>

LdapUserFederationId

The ldap user federation provider to attach this mapper to.

Declaration

public Output<string> LdapUserFederationId { get; }

Property Value

Type	Description
Output<System.String>

Name

Display name of the mapper when displayed in the console.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

ReadOnly

Declaration

public Output<bool?> ReadOnly { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

RealmId

The realm in which the ldap user federation provider exists.

Declaration

public Output<string> RealmId { get; }

Property Value

Type	Description
Output<System.String>

WriteOnly

Declaration

public Output<bool?> WriteOnly { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Methods

Get(String, Input<String>, FullNameMapperState, CustomResourceOptions)

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

Declaration

public static FullNameMapper Get(string name, Input<string> id, FullNameMapperState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
FullNameMapperState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
FullNameMapper