Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Keycloak Provider
  3. API Docs
  4. GenericClientProtocolMapper
Keycloak v6.4.0 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-keycloak

keycloak.GenericClientProtocolMapper

Explore with Pulumi AI

Keycloak v6.4.0 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-keycloak

!> WARNING: This resource is deprecated and will be removed in the next major version. Please use keycloak.GenericProtocolMapper instead.

Allows for creating and managing protocol mappers for both types of clients (openid-connect and saml) within Keycloak.

There are two uses cases for using this resource:

  • If you implemented a custom protocol mapper, this resource can be used to configure it
  • If the provider doesn’t support a particular protocol mapper, this resource can be used instead.

Due to the generic nature of this mapper, it is less user-friendly and more prone to configuration errors. Therefore, if possible, a specific mapper should be used.

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: "test-client",
});
const samlHardcodeAttributeMapper = new keycloak.GenericClientProtocolMapper("saml_hardcode_attribute_mapper", {
    realmId: realm.id,
    clientId: samlClient.id,
    name: "test-mapper",
    protocol: "saml",
    protocolMapper: "saml-hardcode-attribute-mapper",
    config: {
        "attribute.name": "name",
        "attribute.nameformat": "Basic",
        "attribute.value": "value",
        "friendly.name": "display name",
    },
});
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="test-client")
saml_hardcode_attribute_mapper = keycloak.GenericClientProtocolMapper("saml_hardcode_attribute_mapper",
    realm_id=realm.id,
    client_id=saml_client.id,
    name="test-mapper",
    protocol="saml",
    protocol_mapper="saml-hardcode-attribute-mapper",
    config={
        "attribute.name": "name",
        "attribute.nameformat": "Basic",
        "attribute.value": "value",
        "friendly.name": "display name",
    })
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("test-client"),
		})
		if err != nil {
			return err
		}
		_, err = keycloak.NewGenericClientProtocolMapper(ctx, "saml_hardcode_attribute_mapper", &keycloak.GenericClientProtocolMapperArgs{
			RealmId:        realm.ID(),
			ClientId:       samlClient.ID(),
			Name:           pulumi.String("test-mapper"),
			Protocol:       pulumi.String("saml"),
			ProtocolMapper: pulumi.String("saml-hardcode-attribute-mapper"),
			Config: pulumi.StringMap{
				"attribute.name":       pulumi.String("name"),
				"attribute.nameformat": pulumi.String("Basic"),
				"attribute.value":      pulumi.String("value"),
				"friendly.name":        pulumi.String("display name"),
			},
		})
		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 = "test-client",
    });

    var samlHardcodeAttributeMapper = new Keycloak.GenericClientProtocolMapper("saml_hardcode_attribute_mapper", new()
    {
        RealmId = realm.Id,
        ClientId = samlClient.Id,
        Name = "test-mapper",
        Protocol = "saml",
        ProtocolMapper = "saml-hardcode-attribute-mapper",
        Config = 
        {
            { "attribute.name", "name" },
            { "attribute.nameformat", "Basic" },
            { "attribute.value", "value" },
            { "friendly.name", "display name" },
        },
    });

});
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.GenericClientProtocolMapper;
import com.pulumi.keycloak.GenericClientProtocolMapperArgs;
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("test-client")
            .build());

        var samlHardcodeAttributeMapper = new GenericClientProtocolMapper("samlHardcodeAttributeMapper", GenericClientProtocolMapperArgs.builder()
            .realmId(realm.id())
            .clientId(samlClient.id())
            .name("test-mapper")
            .protocol("saml")
            .protocolMapper("saml-hardcode-attribute-mapper")
            .config(Map.ofEntries(
                Map.entry("attribute.name", "name"),
                Map.entry("attribute.nameformat", "Basic"),
                Map.entry("attribute.value", "value"),
                Map.entry("friendly.name", "display name")
            ))
            .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: test-client
  samlHardcodeAttributeMapper:
    type: keycloak:GenericClientProtocolMapper
    name: saml_hardcode_attribute_mapper
    properties:
      realmId: ${realm.id}
      clientId: ${samlClient.id}
      name: test-mapper
      protocol: saml
      protocolMapper: saml-hardcode-attribute-mapper
      config:
        attribute.name: name
        attribute.nameformat: Basic
        attribute.value: value
        friendly.name: display name
Copy

Create GenericClientProtocolMapper Resource

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

Constructor syntax

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

@overload
def GenericClientProtocolMapper(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                config: Optional[Mapping[str, str]] = None,
                                protocol: Optional[str] = None,
                                protocol_mapper: Optional[str] = None,
                                realm_id: Optional[str] = None,
                                client_id: Optional[str] = None,
                                client_scope_id: Optional[str] = None,
                                name: Optional[str] = None)
func NewGenericClientProtocolMapper(ctx *Context, name string, args GenericClientProtocolMapperArgs, opts ...ResourceOption) (*GenericClientProtocolMapper, error)
public GenericClientProtocolMapper(string name, GenericClientProtocolMapperArgs args, CustomResourceOptions? opts = null)
public GenericClientProtocolMapper(String name, GenericClientProtocolMapperArgs args)
public GenericClientProtocolMapper(String name, GenericClientProtocolMapperArgs args, CustomResourceOptions options)

type: keycloak:GenericClientProtocolMapper
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. GenericClientProtocolMapperArgs
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. GenericClientProtocolMapperArgs
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. GenericClientProtocolMapperArgs
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. GenericClientProtocolMapperArgs
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. GenericClientProtocolMapperArgs
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 genericClientProtocolMapperResource = new Keycloak.GenericClientProtocolMapper("genericClientProtocolMapperResource", new()
{
    Config = 
    {
        { "string", "string" },
    },
    Protocol = "string",
    ProtocolMapper = "string",
    RealmId = "string",
    ClientId = "string",
    ClientScopeId = "string",
    Name = "string",
});
Copy
example, err := keycloak.NewGenericClientProtocolMapper(ctx, "genericClientProtocolMapperResource", &keycloak.GenericClientProtocolMapperArgs{
	Config: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Protocol:       pulumi.String("string"),
	ProtocolMapper: pulumi.String("string"),
	RealmId:        pulumi.String("string"),
	ClientId:       pulumi.String("string"),
	ClientScopeId:  pulumi.String("string"),
	Name:           pulumi.String("string"),
})
Copy
var genericClientProtocolMapperResource = new GenericClientProtocolMapper("genericClientProtocolMapperResource", GenericClientProtocolMapperArgs.builder()
    .config(Map.of("string", "string"))
    .protocol("string")
    .protocolMapper("string")
    .realmId("string")
    .clientId("string")
    .clientScopeId("string")
    .name("string")
    .build());
Copy
generic_client_protocol_mapper_resource = keycloak.GenericClientProtocolMapper("genericClientProtocolMapperResource",
    config={
        "string": "string",
    },
    protocol="string",
    protocol_mapper="string",
    realm_id="string",
    client_id="string",
    client_scope_id="string",
    name="string")
Copy
const genericClientProtocolMapperResource = new keycloak.GenericClientProtocolMapper("genericClientProtocolMapperResource", {
    config: {
        string: "string",
    },
    protocol: "string",
    protocolMapper: "string",
    realmId: "string",
    clientId: "string",
    clientScopeId: "string",
    name: "string",
});
Copy
type: keycloak:GenericClientProtocolMapper
properties:
    clientId: string
    clientScopeId: string
    config:
        string: string
    name: string
    protocol: string
    protocolMapper: string
    realmId: string
Copy

GenericClientProtocolMapper 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 GenericClientProtocolMapper resource accepts the following input properties:

Config This property is required. Dictionary<string, string>
A map with key / value pairs for configuring the protocol mapper. The supported keys depends on the protocol mapper.
Protocol
This property is required.
Changes to this property will trigger replacement.
string
The type of client (either openid-connect or saml). The type must match the type of the client.
ProtocolMapper
This property is required.
Changes to this property will trigger replacement.
string
The name of the protocol mapper. The protocol mapper must be compatible with the specified client.
RealmId
This property is required.
Changes to this property will trigger replacement.
string
The realm this protocol mapper exists within.
ClientId Changes to this property will trigger replacement. string
The client this protocol mapper is attached to.
ClientScopeId Changes to this property will trigger replacement. string
The mapper's associated client scope. Cannot be used at the same time as client_id.
Name Changes to this property will trigger replacement. string
The display name of this protocol mapper in the GUI.
Config This property is required. map[string]string
A map with key / value pairs for configuring the protocol mapper. The supported keys depends on the protocol mapper.
Protocol
This property is required.
Changes to this property will trigger replacement.
string
The type of client (either openid-connect or saml). The type must match the type of the client.
ProtocolMapper
This property is required.
Changes to this property will trigger replacement.
string
The name of the protocol mapper. The protocol mapper must be compatible with the specified client.
RealmId
This property is required.
Changes to this property will trigger replacement.
string
The realm this protocol mapper exists within.
ClientId Changes to this property will trigger replacement. string
The client this protocol mapper is attached to.
ClientScopeId Changes to this property will trigger replacement. string
The mapper's associated client scope. Cannot be used at the same time as client_id.
Name Changes to this property will trigger replacement. string
The display name of this protocol mapper in the GUI.
config This property is required. Map<String,String>
A map with key / value pairs for configuring the protocol mapper. The supported keys depends on the protocol mapper.
protocol
This property is required.
Changes to this property will trigger replacement.
String
The type of client (either openid-connect or saml). The type must match the type of the client.
protocolMapper
This property is required.
Changes to this property will trigger replacement.
String
The name of the protocol mapper. The protocol mapper must be compatible with the specified client.
realmId
This property is required.
Changes to this property will trigger replacement.
String
The realm this protocol mapper exists within.
clientId Changes to this property will trigger replacement. String
The client this protocol mapper is attached to.
clientScopeId Changes to this property will trigger replacement. String
The mapper's associated client scope. Cannot be used at the same time as client_id.
name Changes to this property will trigger replacement. String
The display name of this protocol mapper in the GUI.
config This property is required. {[key: string]: string}
A map with key / value pairs for configuring the protocol mapper. The supported keys depends on the protocol mapper.
protocol
This property is required.
Changes to this property will trigger replacement.
string
The type of client (either openid-connect or saml). The type must match the type of the client.
protocolMapper
This property is required.
Changes to this property will trigger replacement.
string
The name of the protocol mapper. The protocol mapper must be compatible with the specified client.
realmId
This property is required.
Changes to this property will trigger replacement.
string
The realm this protocol mapper exists within.
clientId Changes to this property will trigger replacement. string
The client this protocol mapper is attached to.
clientScopeId Changes to this property will trigger replacement. string
The mapper's associated client scope. Cannot be used at the same time as client_id.
name Changes to this property will trigger replacement. string
The display name of this protocol mapper in the GUI.
config This property is required. Mapping[str, str]
A map with key / value pairs for configuring the protocol mapper. The supported keys depends on the protocol mapper.
protocol
This property is required.
Changes to this property will trigger replacement.
str
The type of client (either openid-connect or saml). The type must match the type of the client.
protocol_mapper
This property is required.
Changes to this property will trigger replacement.
str
The name of the protocol mapper. The protocol mapper must be compatible with the specified client.
realm_id
This property is required.
Changes to this property will trigger replacement.
str
The realm this protocol mapper exists within.
client_id Changes to this property will trigger replacement. str
The client this protocol mapper is attached to.
client_scope_id Changes to this property will trigger replacement. str
The mapper's associated client scope. Cannot be used at the same time as client_id.
name Changes to this property will trigger replacement. str
The display name of this protocol mapper in the GUI.
config This property is required. Map<String>
A map with key / value pairs for configuring the protocol mapper. The supported keys depends on the protocol mapper.
protocol
This property is required.
Changes to this property will trigger replacement.
String
The type of client (either openid-connect or saml). The type must match the type of the client.
protocolMapper
This property is required.
Changes to this property will trigger replacement.
String
The name of the protocol mapper. The protocol mapper must be compatible with the specified client.
realmId
This property is required.
Changes to this property will trigger replacement.
String
The realm this protocol mapper exists within.
clientId Changes to this property will trigger replacement. String
The client this protocol mapper is attached to.
clientScopeId Changes to this property will trigger replacement. String
The mapper's associated client scope. Cannot be used at the same time as client_id.
name Changes to this property will trigger replacement. String
The display name of this protocol mapper in the GUI.

Outputs

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

Get an existing GenericClientProtocolMapper 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?: GenericClientProtocolMapperState, opts?: CustomResourceOptions): GenericClientProtocolMapper
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_id: Optional[str] = None,
        client_scope_id: Optional[str] = None,
        config: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        protocol: Optional[str] = None,
        protocol_mapper: Optional[str] = None,
        realm_id: Optional[str] = None) -> GenericClientProtocolMapper
func GetGenericClientProtocolMapper(ctx *Context, name string, id IDInput, state *GenericClientProtocolMapperState, opts ...ResourceOption) (*GenericClientProtocolMapper, error)
public static GenericClientProtocolMapper Get(string name, Input<string> id, GenericClientProtocolMapperState? state, CustomResourceOptions? opts = null)
public static GenericClientProtocolMapper get(String name, Output<String> id, GenericClientProtocolMapperState state, CustomResourceOptions options)
resources:  _:    type: keycloak:GenericClientProtocolMapper    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 is attached to.
ClientScopeId Changes to this property will trigger replacement. string
The mapper's associated client scope. Cannot be used at the same time as client_id.
Config Dictionary<string, string>
A map with key / value pairs for configuring the protocol mapper. The supported keys depends on the protocol mapper.
Name Changes to this property will trigger replacement. string
The display name of this protocol mapper in the GUI.
Protocol Changes to this property will trigger replacement. string
The type of client (either openid-connect or saml). The type must match the type of the client.
ProtocolMapper Changes to this property will trigger replacement. string
The name of the protocol mapper. The protocol mapper must be compatible with the specified client.
RealmId Changes to this property will trigger replacement. string
The realm this protocol mapper exists within.
ClientId Changes to this property will trigger replacement. string
The client this protocol mapper is attached to.
ClientScopeId Changes to this property will trigger replacement. string
The mapper's associated client scope. Cannot be used at the same time as client_id.
Config map[string]string
A map with key / value pairs for configuring the protocol mapper. The supported keys depends on the protocol mapper.
Name Changes to this property will trigger replacement. string
The display name of this protocol mapper in the GUI.
Protocol Changes to this property will trigger replacement. string
The type of client (either openid-connect or saml). The type must match the type of the client.
ProtocolMapper Changes to this property will trigger replacement. string
The name of the protocol mapper. The protocol mapper must be compatible with the specified client.
RealmId Changes to this property will trigger replacement. string
The realm this protocol mapper exists within.
clientId Changes to this property will trigger replacement. String
The client this protocol mapper is attached to.
clientScopeId Changes to this property will trigger replacement. String
The mapper's associated client scope. Cannot be used at the same time as client_id.
config Map<String,String>
A map with key / value pairs for configuring the protocol mapper. The supported keys depends on the protocol mapper.
name Changes to this property will trigger replacement. String
The display name of this protocol mapper in the GUI.
protocol Changes to this property will trigger replacement. String
The type of client (either openid-connect or saml). The type must match the type of the client.
protocolMapper Changes to this property will trigger replacement. String
The name of the protocol mapper. The protocol mapper must be compatible with the specified client.
realmId Changes to this property will trigger replacement. String
The realm this protocol mapper exists within.
clientId Changes to this property will trigger replacement. string
The client this protocol mapper is attached to.
clientScopeId Changes to this property will trigger replacement. string
The mapper's associated client scope. Cannot be used at the same time as client_id.
config {[key: string]: string}
A map with key / value pairs for configuring the protocol mapper. The supported keys depends on the protocol mapper.
name Changes to this property will trigger replacement. string
The display name of this protocol mapper in the GUI.
protocol Changes to this property will trigger replacement. string
The type of client (either openid-connect or saml). The type must match the type of the client.
protocolMapper Changes to this property will trigger replacement. string
The name of the protocol mapper. The protocol mapper must be compatible with the specified client.
realmId Changes to this property will trigger replacement. string
The realm this protocol mapper exists within.
client_id Changes to this property will trigger replacement. str
The client this protocol mapper is attached to.
client_scope_id Changes to this property will trigger replacement. str
The mapper's associated client scope. Cannot be used at the same time as client_id.
config Mapping[str, str]
A map with key / value pairs for configuring the protocol mapper. The supported keys depends on the protocol mapper.
name Changes to this property will trigger replacement. str
The display name of this protocol mapper in the GUI.
protocol Changes to this property will trigger replacement. str
The type of client (either openid-connect or saml). The type must match the type of the client.
protocol_mapper Changes to this property will trigger replacement. str
The name of the protocol mapper. The protocol mapper must be compatible with the specified client.
realm_id Changes to this property will trigger replacement. str
The realm this protocol mapper exists within.
clientId Changes to this property will trigger replacement. String
The client this protocol mapper is attached to.
clientScopeId Changes to this property will trigger replacement. String
The mapper's associated client scope. Cannot be used at the same time as client_id.
config Map<String>
A map with key / value pairs for configuring the protocol mapper. The supported keys depends on the protocol mapper.
name Changes to this property will trigger replacement. String
The display name of this protocol mapper in the GUI.
protocol Changes to this property will trigger replacement. String
The type of client (either openid-connect or saml). The type must match the type of the client.
protocolMapper Changes to this property will trigger replacement. String
The name of the protocol mapper. The protocol mapper must be compatible with the specified client.
realmId Changes to this property will trigger replacement. String
The realm this protocol mapper exists within.

Import

Protocol mappers can be imported using the following format: {{realm_id}}/client/{{client_keycloak_id}}/{{protocol_mapper_id}}

Example:

bash

$ pulumi import keycloak:index/genericClientProtocolMapper:GenericClientProtocolMapper saml_hardcode_attribute_mapper my-realm/client/a7202154-8793-4656-b655-1dd18c181e14/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.4.0 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-keycloak