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

UserPropertyProtocolMapperArgs

data class UserPropertyProtocolMapperArgs(val clientId: Output<String>? = null, val clientScopeId: Output<String>? = null, val friendlyName: Output<String>? = null, val name: Output<String>? = null, val realmId: Output<String>? = null, val samlAttributeName: Output<String>? = null, val samlAttributeNameFormat: Output<String>? = null, val userProperty: Output<String>? = null) : ConvertibleToJava<UserPropertyProtocolMapperArgs>

# keycloak.saml.UserPropertyProtocolMapper

Allows for creating and managing user property protocol mappers for SAML clients within Keycloak. SAML user property protocol mappers allow you to map properties of the Keycloak user model 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 (Client)

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: test.id,
    clientId: "test-saml-client",
    name: "test-saml-client",
});
const samlUserPropertyMapper = new keycloak.saml.UserPropertyProtocolMapper("saml_user_property_mapper", {
    realmId: test.id,
    clientId: samlClient.id,
    name: "email-user-property-mapper",
    userProperty: "email",
    samlAttributeName: "email",
    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=test["id"],
    client_id="test-saml-client",
    name="test-saml-client")
saml_user_property_mapper = keycloak.saml.UserPropertyProtocolMapper("saml_user_property_mapper",
    realm_id=test["id"],
    client_id=saml_client.id,
    name="email-user-property-mapper",
    user_property="email",
    saml_attribute_name="email",
    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 = test.Id,
        ClientId = "test-saml-client",
        Name = "test-saml-client",
    });
    var samlUserPropertyMapper = new Keycloak.Saml.UserPropertyProtocolMapper("saml_user_property_mapper", new()
    {
        RealmId = test.Id,
        ClientId = samlClient.Id,
        Name = "email-user-property-mapper",
        UserProperty = "email",
        SamlAttributeName = "email",
        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 {
		_, 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:  pulumi.Any(test.Id),
			ClientId: pulumi.String("test-saml-client"),
			Name:     pulumi.String("test-saml-client"),
		})
		if err != nil {
			return err
		}
		_, err = saml.NewUserPropertyProtocolMapper(ctx, "saml_user_property_mapper", &saml.UserPropertyProtocolMapperArgs{
			RealmId:                 pulumi.Any(test.Id),
			ClientId:                samlClient.ID(),
			Name:                    pulumi.String("email-user-property-mapper"),
			UserProperty:            pulumi.String("email"),
			SamlAttributeName:       pulumi.String("email"),
			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.UserPropertyProtocolMapper;
import com.pulumi.keycloak.saml.UserPropertyProtocolMapperArgs;
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(test.id())
            .clientId("test-saml-client")
            .name("test-saml-client")
            .build());
        var samlUserPropertyMapper = new UserPropertyProtocolMapper("samlUserPropertyMapper", UserPropertyProtocolMapperArgs.builder()
            .realmId(test.id())
            .clientId(samlClient.id())
            .name("email-user-property-mapper")
            .userProperty("email")
            .samlAttributeName("email")
            .samlAttributeNameFormat("Unspecified")
            .build());
    }
}

resources:
  realm:
    type: keycloak:Realm
    properties:
      realm: my-realm
      enabled: true
  samlClient:
    type: keycloak:saml:Client
    name: saml_client
    properties:
      realmId: ${test.id}
      clientId: test-saml-client
      name: test-saml-client
  samlUserPropertyMapper:
    type: keycloak:saml:UserPropertyProtocolMapper
    name: saml_user_property_mapper
    properties:
      realmId: ${test.id}
      clientId: ${samlClient.id}
      name: email-user-property-mapper
      userProperty: email
      samlAttributeName: email
      samlAttributeNameFormat: Unspecified

Argument Reference

The following arguments are supported:

realm_id - (Required) The realm this protocol mapper exists within.
client_id - (Required if client_scope_id is not specified) The SAML client this protocol mapper is attached to.
client_scope_id - (Required if client_id is not specified) The SAML client scope this protocol mapper is attached to.
name - (Required) The display name of this protocol mapper in the GUI.
user_property - (Required) The property of the Keycloak user model to map.
friendly_name - (Optional) An optional human-friendly name for this attribute.
saml_attribute_name - (Required) The name of the SAML attribute.
saml_attribute_name_format - (Required) The SAML attribute Name Format. Can be one of Unspecified, Basic, or URI Reference.

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:

$ terraform import keycloak_saml_user_property_protocol_mapper.saml_user_property_mapper my-realm/client/a7202154-8793-4656-b655-1dd18c181e14/71602afa-f7d1-4788-8c49-ef8fd00af0f4
$ terraform import keycloak_saml_user_property_protocol_mapper.saml_user_property_mapper my-realm/client-scope/b799ea7e-73ee-4a73-990a-1eafebe8e20a/71602afa-f7d1-4788-8c49-ef8fd00af0f4

Constructors

UserPropertyProtocolMapperArgs

constructor(clientId: Output<String>? = null, clientScopeId: Output<String>? = null, friendlyName: Output<String>? = null, name: Output<String>? = null, realmId: Output<String>? = null, samlAttributeName: Output<String>? = null, samlAttributeNameFormat: Output<String>? = null, userProperty: Output<String>? = null)