pulumi-keycloak-kotlin/com.pulumi.keycloak.kotlin/UserTemplateImporterIdentityProviderMapperArgs

UserTemplateImporterIdentityProviderMapperArgs

data class UserTemplateImporterIdentityProviderMapperArgs(val extraConfig: Output<Map<String, String>>? = null, val identityProviderAlias: Output<String>? = null, val name: Output<String>? = null, val realm: Output<String>? = null, val template: Output<String>? = null) : ConvertibleToJava<UserTemplateImporterIdentityProviderMapperArgs>

Allows for creating and managing an username template importer identity provider mapper within Keycloak. The username template importer mapper can be used to map externally defined OIDC claims or SAML attributes with a template to the username of the imported Keycloak user:

  • Substitutions are enclosed in \${}. For example: '\${ALIAS}.\${CLAIM.sub}'. ALIAS is the provider alias. CLAIM.\ references an ID or Access token claim.

If you are using Keycloak 10 or higher, you will need to specify the extra_config argument in order to define a syncMode for the mapper.

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 oidc = new keycloak.oidc.IdentityProvider("oidc", {
    realm: realm.id,
    alias: "oidc",
    authorizationUrl: "https://example.com/auth",
    tokenUrl: "https://example.com/token",
    clientId: "example_id",
    clientSecret: "example_token",
    defaultScopes: "openid random profile",
});
const usernameImporter = new keycloak.UserTemplateImporterIdentityProviderMapper("username_importer", {
    realm: realm.id,
    name: "username-template-importer",
    identityProviderAlias: oidc.alias,
    template: "${ALIAS}.${CLAIM.email}",
    extraConfig: {
        syncMode: "INHERIT",
    },
});
Content copied to clipboard
import pulumi
import pulumi_keycloak as keycloak
realm = keycloak.Realm("realm",
    realm="my-realm",
    enabled=True)
oidc = keycloak.oidc.IdentityProvider("oidc",
    realm=realm.id,
    alias="oidc",
    authorization_url="https://example.com/auth",
    token_url="https://example.com/token",
    client_id="example_id",
    client_secret="example_token",
    default_scopes="openid random profile")
username_importer = keycloak.UserTemplateImporterIdentityProviderMapper("username_importer",
    realm=realm.id,
    name="username-template-importer",
    identity_provider_alias=oidc.alias,
    template="${ALIAS}.${CLAIM.email}",
    extra_config={
        "syncMode": "INHERIT",
    })
Content copied to clipboard
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 oidc = new Keycloak.Oidc.IdentityProvider("oidc", new()
    {
        Realm = realm.Id,
        Alias = "oidc",
        AuthorizationUrl = "https://example.com/auth",
        TokenUrl = "https://example.com/token",
        ClientId = "example_id",
        ClientSecret = "example_token",
        DefaultScopes = "openid random profile",
    });
    var usernameImporter = new Keycloak.UserTemplateImporterIdentityProviderMapper("username_importer", new()
    {
        Realm = realm.Id,
        Name = "username-template-importer",
        IdentityProviderAlias = oidc.Alias,
        Template = "${ALIAS}.${CLAIM.email}",
        ExtraConfig =
        {
            { "syncMode", "INHERIT" },
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-keycloak/sdk/v5/go/keycloak"
	"github.com/pulumi/pulumi-keycloak/sdk/v5/go/keycloak/oidc"
	"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
		}
		oidc, err := oidc.NewIdentityProvider(ctx, "oidc", &oidc.IdentityProviderArgs{
			Realm:            realm.ID(),
			Alias:            pulumi.String("oidc"),
			AuthorizationUrl: pulumi.String("https://example.com/auth"),
			TokenUrl:         pulumi.String("https://example.com/token"),
			ClientId:         pulumi.String("example_id"),
			ClientSecret:     pulumi.String("example_token"),
			DefaultScopes:    pulumi.String("openid random profile"),
		})
		if err != nil {
			return err
		}
		_, err = keycloak.NewUserTemplateImporterIdentityProviderMapper(ctx, "username_importer", &keycloak.UserTemplateImporterIdentityProviderMapperArgs{
			Realm:                 realm.ID(),
			Name:                  pulumi.String("username-template-importer"),
			IdentityProviderAlias: oidc.Alias,
			Template:              pulumi.String("${ALIAS}.${CLAIM.email}"),
			ExtraConfig: pulumi.StringMap{
				"syncMode": pulumi.String("INHERIT"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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.oidc.IdentityProvider;
import com.pulumi.keycloak.oidc.IdentityProviderArgs;
import com.pulumi.keycloak.UserTemplateImporterIdentityProviderMapper;
import com.pulumi.keycloak.UserTemplateImporterIdentityProviderMapperArgs;
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 oidc = new IdentityProvider("oidc", IdentityProviderArgs.builder()
            .realm(realm.id())
            .alias("oidc")
            .authorizationUrl("https://example.com/auth")
            .tokenUrl("https://example.com/token")
            .clientId("example_id")
            .clientSecret("example_token")
            .defaultScopes("openid random profile")
            .build());
        var usernameImporter = new UserTemplateImporterIdentityProviderMapper("usernameImporter", UserTemplateImporterIdentityProviderMapperArgs.builder()
            .realm(realm.id())
            .name("username-template-importer")
            .identityProviderAlias(oidc.alias())
            .template("${ALIAS}.${CLAIM.email}")
            .extraConfig(Map.of("syncMode", "INHERIT"))
            .build());
    }
}
Content copied to clipboard
resources:
  realm:
    type: keycloak:Realm
    properties:
      realm: my-realm
      enabled: true
  oidc:
    type: keycloak:oidc:IdentityProvider
    properties:
      realm: ${realm.id}
      alias: oidc
      authorizationUrl: https://example.com/auth
      tokenUrl: https://example.com/token
      clientId: example_id
      clientSecret: example_token
      defaultScopes: openid random profile
  usernameImporter:
    type: keycloak:UserTemplateImporterIdentityProviderMapper
    name: username_importer
    properties:
      realm: ${realm.id}
      name: username-template-importer
      identityProviderAlias: ${oidc.alias}
      template: ${ALIAS}.${CLAIM.email}
      extraConfig:
        syncMode: INHERIT
Content copied to clipboard

Import

Identity provider mappers can be imported using the format {{realm_id}}/{{idp_alias}}/{{idp_mapper_id}}, where idp_alias is the identity provider alias, and idp_mapper_id is the unique ID that Keycloak assigns to the mapper upon creation. This value can be found in the URI when editing this mapper in the GUI, and is typically a GUID. Example: bash

$ pulumi import keycloak:index/userTemplateImporterIdentityProviderMapper:UserTemplateImporterIdentityProviderMapper username_importer my-realm/my-mapper/f446db98-7133-4e30-b18a-3d28fde7ca1b
Content copied to clipboard

Constructors

constructor(extraConfig: Output<Map<String, String>>? = null, identityProviderAlias: Output<String>? = null, name: Output<String>? = null, realm: Output<String>? = null, template: Output<String>? = null)

Properties

Link copied to clipboard
val extraConfig: Output<Map<String, String>>? = null

Key/value attributes to add to the identity provider mapper model that is persisted to Keycloak. This can be used to extend the base model with new Keycloak features.

Link copied to clipboard
val identityProviderAlias: Output<String>? = null

The alias of the associated identity provider.

Link copied to clipboard
val name: Output<String>? = null

The name of the mapper.

Link copied to clipboard
val realm: Output<String>? = null

The name of the realm.

Link copied to clipboard
val template: Output<String>? = null

Template to use to format the username to import. Substitutions are enclosed in \${}. For example: '\$\${ALIAS}.\$\${CLAIM.sub}'. ALIAS is the provider alias. CLAIM.\ references an ID or Access token claim.

Functions

Link copied to clipboard
open override fun toJava(): UserTemplateImporterIdentityProviderMapperArgs