Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Keycloak Provider
  3. API Docs
  4. saml
  5. UserPropertyProtocolMapper
Keycloak v6.2.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-keycloak

keycloak.saml.UserPropertyProtocolMapper

Explore with Pulumi AI

Keycloak v6.2.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-keycloak

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

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 samlUserPropertyMapper = new keycloak.saml.UserPropertyProtocolMapper("saml_user_property_mapper", {
    realmId: realm.id,
    clientId: samlClient.id,
    name: "email-user-property-mapper",
    userProperty: "email",
    samlAttributeName: "email",
    samlAttributeNameFormat: "Unspecified",
});
Copy
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_property_mapper = keycloak.saml.UserPropertyProtocolMapper("saml_user_property_mapper",
    realm_id=realm.id,
    client_id=saml_client.id,
    name="email-user-property-mapper",
    user_property="email",
    saml_attribute_name="email",
    saml_attribute_name_format="Unspecified")
Copy
package main

import (
	"github.com/pulumi/pulumi-keycloak/sdk/v6/go/keycloak"
	"github.com/pulumi/pulumi-keycloak/sdk/v6/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.NewUserPropertyProtocolMapper(ctx, "saml_user_property_mapper", &saml.UserPropertyProtocolMapperArgs{
			RealmId:                 realm.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
	})
}
Copy
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 samlUserPropertyMapper = new Keycloak.Saml.UserPropertyProtocolMapper("saml_user_property_mapper", new()
    {
        RealmId = realm.Id,
        ClientId = samlClient.Id,
        Name = "email-user-property-mapper",
        UserProperty = "email",
        SamlAttributeName = "email",
        SamlAttributeNameFormat = "Unspecified",
    });

});
Copy
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(realm.id())
            .clientId("saml-client")
            .name("saml-client")
            .build());

        var samlUserPropertyMapper = new UserPropertyProtocolMapper("samlUserPropertyMapper", UserPropertyProtocolMapperArgs.builder()
            .realmId(realm.id())
            .clientId(samlClient.id())
            .name("email-user-property-mapper")
            .userProperty("email")
            .samlAttributeName("email")
            .samlAttributeNameFormat("Unspecified")
            .build());

    }
}
Copy
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
  samlUserPropertyMapper:
    type: keycloak:saml:UserPropertyProtocolMapper
    name: saml_user_property_mapper
    properties:
      realmId: ${realm.id}
      clientId: ${samlClient.id}
      name: email-user-property-mapper
      userProperty: email
      samlAttributeName: email
      samlAttributeNameFormat: Unspecified
Copy

Create UserPropertyProtocolMapper Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new UserPropertyProtocolMapper(name: string, args: UserPropertyProtocolMapperArgs, opts?: CustomResourceOptions);
@overload
def UserPropertyProtocolMapper(resource_name: str,
                               args: UserPropertyProtocolMapperArgs,
                               opts: Optional[ResourceOptions] = None)

@overload
def UserPropertyProtocolMapper(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               realm_id: Optional[str] = None,
                               saml_attribute_name: Optional[str] = None,
                               saml_attribute_name_format: Optional[str] = None,
                               user_property: Optional[str] = None,
                               client_id: Optional[str] = None,
                               client_scope_id: Optional[str] = None,
                               friendly_name: Optional[str] = None,
                               name: Optional[str] = None)
func NewUserPropertyProtocolMapper(ctx *Context, name string, args UserPropertyProtocolMapperArgs, opts ...ResourceOption) (*UserPropertyProtocolMapper, error)
public UserPropertyProtocolMapper(string name, UserPropertyProtocolMapperArgs args, CustomResourceOptions? opts = null)
public UserPropertyProtocolMapper(String name, UserPropertyProtocolMapperArgs args)
public UserPropertyProtocolMapper(String name, UserPropertyProtocolMapperArgs args, CustomResourceOptions options)

type: keycloak:saml:UserPropertyProtocolMapper
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. UserPropertyProtocolMapperArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. UserPropertyProtocolMapperArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. UserPropertyProtocolMapperArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. UserPropertyProtocolMapperArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. UserPropertyProtocolMapperArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var keycloakUserPropertyProtocolMapperResource = new Keycloak.Saml.UserPropertyProtocolMapper("keycloakUserPropertyProtocolMapperResource", new()
{
    RealmId = "string",
    SamlAttributeName = "string",
    SamlAttributeNameFormat = "string",
    UserProperty = "string",
    ClientId = "string",
    ClientScopeId = "string",
    FriendlyName = "string",
    Name = "string",
});
Copy
example, err := saml.NewUserPropertyProtocolMapper(ctx, "keycloakUserPropertyProtocolMapperResource", &saml.UserPropertyProtocolMapperArgs{
	RealmId:                 pulumi.String("string"),
	SamlAttributeName:       pulumi.String("string"),
	SamlAttributeNameFormat: pulumi.String("string"),
	UserProperty:            pulumi.String("string"),
	ClientId:                pulumi.String("string"),
	ClientScopeId:           pulumi.String("string"),
	FriendlyName:            pulumi.String("string"),
	Name:                    pulumi.String("string"),
})
Copy
var keycloakUserPropertyProtocolMapperResource = new UserPropertyProtocolMapper("keycloakUserPropertyProtocolMapperResource", UserPropertyProtocolMapperArgs.builder()
    .realmId("string")
    .samlAttributeName("string")
    .samlAttributeNameFormat("string")
    .userProperty("string")
    .clientId("string")
    .clientScopeId("string")
    .friendlyName("string")
    .name("string")
    .build());
Copy
keycloak_user_property_protocol_mapper_resource = keycloak.saml.UserPropertyProtocolMapper("keycloakUserPropertyProtocolMapperResource",
    realm_id="string",
    saml_attribute_name="string",
    saml_attribute_name_format="string",
    user_property="string",
    client_id="string",
    client_scope_id="string",
    friendly_name="string",
    name="string")
Copy
const keycloakUserPropertyProtocolMapperResource = new keycloak.saml.UserPropertyProtocolMapper("keycloakUserPropertyProtocolMapperResource", {
    realmId: "string",
    samlAttributeName: "string",
    samlAttributeNameFormat: "string",
    userProperty: "string",
    clientId: "string",
    clientScopeId: "string",
    friendlyName: "string",
    name: "string",
});
Copy
type: keycloak:saml:UserPropertyProtocolMapper
properties:
    clientId: string
    clientScopeId: string
    friendlyName: string
    name: string
    realmId: string
    samlAttributeName: string
    samlAttributeNameFormat: string
    userProperty: string
Copy

UserPropertyProtocolMapper Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The UserPropertyProtocolMapper resource accepts the following input properties:

RealmId
This property is required.
Changes to this property will trigger replacement.
string
The realm this protocol mapper exists within.
SamlAttributeName This property is required. string
The name of the SAML attribute.
SamlAttributeNameFormat This property is required. string
The SAML attribute Name Format. Can be one of Unspecified, Basic, or URI Reference.
UserProperty This property is required. string
The property of the Keycloak user model to map.
ClientId Changes to this property will trigger replacement. string
The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
ClientScopeId Changes to this property will trigger replacement. string
The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified.
FriendlyName string
An optional human-friendly name for this attribute.
Name string
The display name of this protocol mapper in the GUI.
RealmId
This property is required.
Changes to this property will trigger replacement.
string
The realm this protocol mapper exists within.
SamlAttributeName This property is required. string
The name of the SAML attribute.
SamlAttributeNameFormat This property is required. string
The SAML attribute Name Format. Can be one of Unspecified, Basic, or URI Reference.
UserProperty This property is required. string
The property of the Keycloak user model to map.
ClientId Changes to this property will trigger replacement. string
The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
ClientScopeId Changes to this property will trigger replacement. string
The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified.
FriendlyName string
An optional human-friendly name for this attribute.
Name string
The display name of this protocol mapper in the GUI.
realmId
This property is required.
Changes to this property will trigger replacement.
String
The realm this protocol mapper exists within.
samlAttributeName This property is required. String
The name of the SAML attribute.
samlAttributeNameFormat This property is required. String
The SAML attribute Name Format. Can be one of Unspecified, Basic, or URI Reference.
userProperty This property is required. String
The property of the Keycloak user model to map.
clientId Changes to this property will trigger replacement. String
The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
clientScopeId Changes to this property will trigger replacement. String
The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified.
friendlyName String
An optional human-friendly name for this attribute.
name String
The display name of this protocol mapper in the GUI.
realmId
This property is required.
Changes to this property will trigger replacement.
string
The realm this protocol mapper exists within.
samlAttributeName This property is required. string
The name of the SAML attribute.
samlAttributeNameFormat This property is required. string
The SAML attribute Name Format. Can be one of Unspecified, Basic, or URI Reference.
userProperty This property is required. string
The property of the Keycloak user model to map.
clientId Changes to this property will trigger replacement. string
The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
clientScopeId Changes to this property will trigger replacement. string
The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified.
friendlyName string
An optional human-friendly name for this attribute.
name string
The display name of this protocol mapper in the GUI.
realm_id
This property is required.
Changes to this property will trigger replacement.
str
The realm this protocol mapper exists within.
saml_attribute_name This property is required. str
The name of the SAML attribute.
saml_attribute_name_format This property is required. str
The SAML attribute Name Format. Can be one of Unspecified, Basic, or URI Reference.
user_property This property is required. str
The property of the Keycloak user model to map.
client_id Changes to this property will trigger replacement. str
The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
client_scope_id Changes to this property will trigger replacement. str
The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified.
friendly_name str
An optional human-friendly name for this attribute.
name str
The display name of this protocol mapper in the GUI.
realmId
This property is required.
Changes to this property will trigger replacement.
String
The realm this protocol mapper exists within.
samlAttributeName This property is required. String
The name of the SAML attribute.
samlAttributeNameFormat This property is required. String
The SAML attribute Name Format. Can be one of Unspecified, Basic, or URI Reference.
userProperty This property is required. String
The property of the Keycloak user model to map.
clientId Changes to this property will trigger replacement. String
The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
clientScopeId Changes to this property will trigger replacement. String
The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified.
friendlyName String
An optional human-friendly name for this attribute.
name String
The display name of this protocol mapper in the GUI.

Outputs

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

Get an existing UserPropertyProtocolMapper 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?: UserPropertyProtocolMapperState, opts?: CustomResourceOptions): UserPropertyProtocolMapper
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_id: Optional[str] = None,
        client_scope_id: Optional[str] = None,
        friendly_name: Optional[str] = None,
        name: Optional[str] = None,
        realm_id: Optional[str] = None,
        saml_attribute_name: Optional[str] = None,
        saml_attribute_name_format: Optional[str] = None,
        user_property: Optional[str] = None) -> UserPropertyProtocolMapper
func GetUserPropertyProtocolMapper(ctx *Context, name string, id IDInput, state *UserPropertyProtocolMapperState, opts ...ResourceOption) (*UserPropertyProtocolMapper, error)
public static UserPropertyProtocolMapper Get(string name, Input<string> id, UserPropertyProtocolMapperState? state, CustomResourceOptions? opts = null)
public static UserPropertyProtocolMapper get(String name, Output<String> id, UserPropertyProtocolMapperState state, CustomResourceOptions options)
resources:  _:    type: keycloak:saml:UserPropertyProtocolMapper    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ClientId Changes to this property will trigger replacement. string
The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
ClientScopeId Changes to this property will trigger replacement. string
The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified.
FriendlyName string
An optional human-friendly name for this attribute.
Name string
The display name of this protocol mapper in the GUI.
RealmId Changes to this property will trigger replacement. string
The realm this protocol mapper exists within.
SamlAttributeName string
The name of the SAML attribute.
SamlAttributeNameFormat string
The SAML attribute Name Format. Can be one of Unspecified, Basic, or URI Reference.
UserProperty string
The property of the Keycloak user model to map.
ClientId Changes to this property will trigger replacement. string
The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
ClientScopeId Changes to this property will trigger replacement. string
The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified.
FriendlyName string
An optional human-friendly name for this attribute.
Name string
The display name of this protocol mapper in the GUI.
RealmId Changes to this property will trigger replacement. string
The realm this protocol mapper exists within.
SamlAttributeName string
The name of the SAML attribute.
SamlAttributeNameFormat string
The SAML attribute Name Format. Can be one of Unspecified, Basic, or URI Reference.
UserProperty string
The property of the Keycloak user model to map.
clientId Changes to this property will trigger replacement. String
The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
clientScopeId Changes to this property will trigger replacement. String
The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified.
friendlyName String
An optional human-friendly name for this attribute.
name String
The display name of this protocol mapper in the GUI.
realmId Changes to this property will trigger replacement. String
The realm this protocol mapper exists within.
samlAttributeName String
The name of the SAML attribute.
samlAttributeNameFormat String
The SAML attribute Name Format. Can be one of Unspecified, Basic, or URI Reference.
userProperty String
The property of the Keycloak user model to map.
clientId Changes to this property will trigger replacement. string
The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
clientScopeId Changes to this property will trigger replacement. string
The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified.
friendlyName string
An optional human-friendly name for this attribute.
name string
The display name of this protocol mapper in the GUI.
realmId Changes to this property will trigger replacement. string
The realm this protocol mapper exists within.
samlAttributeName string
The name of the SAML attribute.
samlAttributeNameFormat string
The SAML attribute Name Format. Can be one of Unspecified, Basic, or URI Reference.
userProperty string
The property of the Keycloak user model to map.
client_id Changes to this property will trigger replacement. str
The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
client_scope_id Changes to this property will trigger replacement. str
The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified.
friendly_name str
An optional human-friendly name for this attribute.
name str
The display name of this protocol mapper in the GUI.
realm_id Changes to this property will trigger replacement. str
The realm this protocol mapper exists within.
saml_attribute_name str
The name of the SAML attribute.
saml_attribute_name_format str
The SAML attribute Name Format. Can be one of Unspecified, Basic, or URI Reference.
user_property str
The property of the Keycloak user model to map.
clientId Changes to this property will trigger replacement. String
The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
clientScopeId Changes to this property will trigger replacement. String
The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified.
friendlyName String
An optional human-friendly name for this attribute.
name String
The display name of this protocol mapper in the GUI.
realmId Changes to this property will trigger replacement. String
The realm this protocol mapper exists within.
samlAttributeName String
The name of the SAML attribute.
samlAttributeNameFormat String
The SAML attribute Name Format. Can be one of Unspecified, Basic, or URI Reference.
userProperty String
The property of the Keycloak user model to map.

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/userPropertyProtocolMapper:UserPropertyProtocolMapper saml_user_property_mapper my-realm/client/a7202154-8793-4656-b655-1dd18c181e14/71602afa-f7d1-4788-8c49-ef8fd00af0f4
Copy
$ pulumi import keycloak:saml/userPropertyProtocolMapper:UserPropertyProtocolMapper saml_user_property_mapper my-realm/client-scope/b799ea7e-73ee-4a73-990a-1eafebe8e20a/71602afa-f7d1-4788-8c49-ef8fd00af0f4
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Keycloak pulumi/pulumi-keycloak
License
Apache-2.0
Notes
This Pulumi package is based on the keycloak Terraform Provider.
Keycloak v6.2.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-keycloak