pulumi-keycloak-kotlin/com.pulumi.keycloak.saml.kotlin/UserAttributeProtocolMapper

UserAttributeProtocolMapper

class UserAttributeProtocolMapper : KotlinCustomResource

Allows for creating and managing user attribute protocol mappers for SAML clients within Keycloak. SAML user attribute protocol mappers allow you to map custom attributes defined for a user within Keycloak to an attribute in a SAML assertion. Protocol mappers can be defined for a single client, or they can be defined for a client scope which can be shared between multiple different clients.

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 samlClient = new keycloak.saml.Client("saml_client", {
    realmId: realm.id,
    clientId: "saml-client",
    name: "saml-client",
});
const samlUserAttributeMapper = new keycloak.saml.UserAttributeProtocolMapper("saml_user_attribute_mapper", {
    realmId: realm.id,
    clientId: samlClient.id,
    name: "displayname-user-attribute-mapper",
    userAttribute: "displayName",
    samlAttributeName: "displayName",
    samlAttributeNameFormat: "Unspecified",
});

import pulumi
import pulumi_keycloak as keycloak
realm = keycloak.Realm("realm",
    realm="my-realm",
    enabled=True)
saml_client = keycloak.saml.Client("saml_client",
    realm_id=realm.id,
    client_id="saml-client",
    name="saml-client")
saml_user_attribute_mapper = keycloak.saml.UserAttributeProtocolMapper("saml_user_attribute_mapper",
    realm_id=realm.id,
    client_id=saml_client.id,
    name="displayname-user-attribute-mapper",
    user_attribute="displayName",
    saml_attribute_name="displayName",
    saml_attribute_name_format="Unspecified")

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 samlClient = new Keycloak.Saml.Client("saml_client", new()
    {
        RealmId = realm.Id,
        ClientId = "saml-client",
        Name = "saml-client",
    });
    var samlUserAttributeMapper = new Keycloak.Saml.UserAttributeProtocolMapper("saml_user_attribute_mapper", new()
    {
        RealmId = realm.Id,
        ClientId = samlClient.Id,
        Name = "displayname-user-attribute-mapper",
        UserAttribute = "displayName",
        SamlAttributeName = "displayName",
        SamlAttributeNameFormat = "Unspecified",
    });
});

package main
import (
	"github.com/pulumi/pulumi-keycloak/sdk/v5/go/keycloak"
	"github.com/pulumi/pulumi-keycloak/sdk/v5/go/keycloak/saml"
	"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
		}
		samlClient, err := saml.NewClient(ctx, "saml_client", &saml.ClientArgs{
			RealmId:  realm.ID(),
			ClientId: pulumi.String("saml-client"),
			Name:     pulumi.String("saml-client"),
		})
		if err != nil {
			return err
		}
		_, err = saml.NewUserAttributeProtocolMapper(ctx, "saml_user_attribute_mapper", &saml.UserAttributeProtocolMapperArgs{
			RealmId:                 realm.ID(),
			ClientId:                samlClient.ID(),
			Name:                    pulumi.String("displayname-user-attribute-mapper"),
			UserAttribute:           pulumi.String("displayName"),
			SamlAttributeName:       pulumi.String("displayName"),
			SamlAttributeNameFormat: pulumi.String("Unspecified"),
		})
		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.saml.Client;
import com.pulumi.keycloak.saml.ClientArgs;
import com.pulumi.keycloak.saml.UserAttributeProtocolMapper;
import com.pulumi.keycloak.saml.UserAttributeProtocolMapperArgs;
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 samlClient = new Client("samlClient", ClientArgs.builder()
            .realmId(realm.id())
            .clientId("saml-client")
            .name("saml-client")
            .build());
        var samlUserAttributeMapper = new UserAttributeProtocolMapper("samlUserAttributeMapper", UserAttributeProtocolMapperArgs.builder()
            .realmId(realm.id())
            .clientId(samlClient.id())
            .name("displayname-user-attribute-mapper")
            .userAttribute("displayName")
            .samlAttributeName("displayName")
            .samlAttributeNameFormat("Unspecified")
            .build());
    }
}

resources:
  realm:
    type: keycloak:Realm
    properties:
      realm: my-realm
      enabled: true
  samlClient:
    type: keycloak:saml:Client
    name: saml_client
    properties:
      realmId: ${realm.id}
      clientId: saml-client
      name: saml-client
  samlUserAttributeMapper:
    type: keycloak:saml:UserAttributeProtocolMapper
    name: saml_user_attribute_mapper
    properties:
      realmId: ${realm.id}
      clientId: ${samlClient.id}
      name: displayname-user-attribute-mapper
      userAttribute: displayName
      samlAttributeName: displayName
      samlAttributeNameFormat: Unspecified

Import

Protocol mappers can be imported using one of the following formats:

Client: {{realm_id}}/client/{{client_keycloak_id}}/{{protocol_mapper_id}}
Client Scope: {{realm_id}}/client-scope/{{client_scope_keycloak_id}}/{{protocol_mapper_id}} Example: bash

$ pulumi import keycloak:saml/userAttributeProtocolMapper:UserAttributeProtocolMapper saml_user_attribute_mapper my-realm/client/a7202154-8793-4656-b655-1dd18c181e14/71602afa-f7d1-4788-8c49-ef8fd00af0f4

$ pulumi import keycloak:saml/userAttributeProtocolMapper:UserAttributeProtocolMapper saml_user_attribute_mapper my-realm/client-scope/b799ea7e-73ee-4a73-990a-1eafebe8e20a/71602afa-f7d1-4788-8c49-ef8fd00af0f4