1. Packages
  2. Keycloak Provider
  3. API Docs
  4. HardcodedAttributeIdentityProviderMapper
Keycloak v6.4.0 published on Wednesday, Apr 16, 2025 by Pulumi

keycloak.HardcodedAttributeIdentityProviderMapper

Explore with Pulumi AI

Allows for creating and managing hardcoded attribute mappers for Keycloak identity provider.

The identity provider hardcoded attribute mapper will set the specified value to the IDP attribute.

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: "my-idp",
    authorizationUrl: "https://authorizationurl.com",
    clientId: "clientID",
    clientSecret: "clientSecret",
    tokenUrl: "https://tokenurl.com",
});
const oidcHardcodedAttributeIdentityProviderMapper = new keycloak.HardcodedAttributeIdentityProviderMapper("oidc", {
    realm: realm.id,
    name: "hardcodedUserSessionAttribute",
    identityProviderAlias: oidc.alias,
    attributeName: "attribute",
    attributeValue: "value",
    userSession: true,
    extraConfig: {
        syncMode: "INHERIT",
    },
});
Copy
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="my-idp",
    authorization_url="https://authorizationurl.com",
    client_id="clientID",
    client_secret="clientSecret",
    token_url="https://tokenurl.com")
oidc_hardcoded_attribute_identity_provider_mapper = keycloak.HardcodedAttributeIdentityProviderMapper("oidc",
    realm=realm.id,
    name="hardcodedUserSessionAttribute",
    identity_provider_alias=oidc.alias,
    attribute_name="attribute",
    attribute_value="value",
    user_session=True,
    extra_config={
        "syncMode": "INHERIT",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-keycloak/sdk/v6/go/keycloak"
	"github.com/pulumi/pulumi-keycloak/sdk/v6/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("my-idp"),
			AuthorizationUrl: pulumi.String("https://authorizationurl.com"),
			ClientId:         pulumi.String("clientID"),
			ClientSecret:     pulumi.String("clientSecret"),
			TokenUrl:         pulumi.String("https://tokenurl.com"),
		})
		if err != nil {
			return err
		}
		_, err = keycloak.NewHardcodedAttributeIdentityProviderMapper(ctx, "oidc", &keycloak.HardcodedAttributeIdentityProviderMapperArgs{
			Realm:                 realm.ID(),
			Name:                  pulumi.String("hardcodedUserSessionAttribute"),
			IdentityProviderAlias: oidc.Alias,
			AttributeName:         pulumi.String("attribute"),
			AttributeValue:        pulumi.String("value"),
			UserSession:           pulumi.Bool(true),
			ExtraConfig: pulumi.StringMap{
				"syncMode": pulumi.String("INHERIT"),
			},
		})
		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 oidc = new Keycloak.Oidc.IdentityProvider("oidc", new()
    {
        Realm = realm.Id,
        Alias = "my-idp",
        AuthorizationUrl = "https://authorizationurl.com",
        ClientId = "clientID",
        ClientSecret = "clientSecret",
        TokenUrl = "https://tokenurl.com",
    });

    var oidcHardcodedAttributeIdentityProviderMapper = new Keycloak.HardcodedAttributeIdentityProviderMapper("oidc", new()
    {
        Realm = realm.Id,
        Name = "hardcodedUserSessionAttribute",
        IdentityProviderAlias = oidc.Alias,
        AttributeName = "attribute",
        AttributeValue = "value",
        UserSession = true,
        ExtraConfig = 
        {
            { "syncMode", "INHERIT" },
        },
    });

});
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.oidc.IdentityProvider;
import com.pulumi.keycloak.oidc.IdentityProviderArgs;
import com.pulumi.keycloak.HardcodedAttributeIdentityProviderMapper;
import com.pulumi.keycloak.HardcodedAttributeIdentityProviderMapperArgs;
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("my-idp")
            .authorizationUrl("https://authorizationurl.com")
            .clientId("clientID")
            .clientSecret("clientSecret")
            .tokenUrl("https://tokenurl.com")
            .build());

        var oidcHardcodedAttributeIdentityProviderMapper = new HardcodedAttributeIdentityProviderMapper("oidcHardcodedAttributeIdentityProviderMapper", HardcodedAttributeIdentityProviderMapperArgs.builder()
            .realm(realm.id())
            .name("hardcodedUserSessionAttribute")
            .identityProviderAlias(oidc.alias())
            .attributeName("attribute")
            .attributeValue("value")
            .userSession(true)
            .extraConfig(Map.of("syncMode", "INHERIT"))
            .build());

    }
}
Copy
resources:
  realm:
    type: keycloak:Realm
    properties:
      realm: my-realm
      enabled: true
  oidc:
    type: keycloak:oidc:IdentityProvider
    properties:
      realm: ${realm.id}
      alias: my-idp
      authorizationUrl: https://authorizationurl.com
      clientId: clientID
      clientSecret: clientSecret
      tokenUrl: https://tokenurl.com
  oidcHardcodedAttributeIdentityProviderMapper:
    type: keycloak:HardcodedAttributeIdentityProviderMapper
    name: oidc
    properties:
      realm: ${realm.id}
      name: hardcodedUserSessionAttribute
      identityProviderAlias: ${oidc.alias}
      attributeName: attribute
      attributeValue: value
      userSession: true
      extraConfig:
        syncMode: INHERIT
Copy

Create HardcodedAttributeIdentityProviderMapper Resource

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

Constructor syntax

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

@overload
def HardcodedAttributeIdentityProviderMapper(resource_name: str,
                                             opts: Optional[ResourceOptions] = None,
                                             identity_provider_alias: Optional[str] = None,
                                             realm: Optional[str] = None,
                                             user_session: Optional[bool] = None,
                                             attribute_name: Optional[str] = None,
                                             attribute_value: Optional[str] = None,
                                             extra_config: Optional[Mapping[str, str]] = None,
                                             name: Optional[str] = None)
func NewHardcodedAttributeIdentityProviderMapper(ctx *Context, name string, args HardcodedAttributeIdentityProviderMapperArgs, opts ...ResourceOption) (*HardcodedAttributeIdentityProviderMapper, error)
public HardcodedAttributeIdentityProviderMapper(string name, HardcodedAttributeIdentityProviderMapperArgs args, CustomResourceOptions? opts = null)
public HardcodedAttributeIdentityProviderMapper(String name, HardcodedAttributeIdentityProviderMapperArgs args)
public HardcodedAttributeIdentityProviderMapper(String name, HardcodedAttributeIdentityProviderMapperArgs args, CustomResourceOptions options)
type: keycloak:HardcodedAttributeIdentityProviderMapper
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. HardcodedAttributeIdentityProviderMapperArgs
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. HardcodedAttributeIdentityProviderMapperArgs
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. HardcodedAttributeIdentityProviderMapperArgs
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. HardcodedAttributeIdentityProviderMapperArgs
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. HardcodedAttributeIdentityProviderMapperArgs
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 hardcodedAttributeIdentityProviderMapperResource = new Keycloak.HardcodedAttributeIdentityProviderMapper("hardcodedAttributeIdentityProviderMapperResource", new()
{
    IdentityProviderAlias = "string",
    Realm = "string",
    UserSession = false,
    AttributeName = "string",
    AttributeValue = "string",
    ExtraConfig = 
    {
        { "string", "string" },
    },
    Name = "string",
});
Copy
example, err := keycloak.NewHardcodedAttributeIdentityProviderMapper(ctx, "hardcodedAttributeIdentityProviderMapperResource", &keycloak.HardcodedAttributeIdentityProviderMapperArgs{
	IdentityProviderAlias: pulumi.String("string"),
	Realm:                 pulumi.String("string"),
	UserSession:           pulumi.Bool(false),
	AttributeName:         pulumi.String("string"),
	AttributeValue:        pulumi.String("string"),
	ExtraConfig: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})
Copy
var hardcodedAttributeIdentityProviderMapperResource = new HardcodedAttributeIdentityProviderMapper("hardcodedAttributeIdentityProviderMapperResource", HardcodedAttributeIdentityProviderMapperArgs.builder()
    .identityProviderAlias("string")
    .realm("string")
    .userSession(false)
    .attributeName("string")
    .attributeValue("string")
    .extraConfig(Map.of("string", "string"))
    .name("string")
    .build());
Copy
hardcoded_attribute_identity_provider_mapper_resource = keycloak.HardcodedAttributeIdentityProviderMapper("hardcodedAttributeIdentityProviderMapperResource",
    identity_provider_alias="string",
    realm="string",
    user_session=False,
    attribute_name="string",
    attribute_value="string",
    extra_config={
        "string": "string",
    },
    name="string")
Copy
const hardcodedAttributeIdentityProviderMapperResource = new keycloak.HardcodedAttributeIdentityProviderMapper("hardcodedAttributeIdentityProviderMapperResource", {
    identityProviderAlias: "string",
    realm: "string",
    userSession: false,
    attributeName: "string",
    attributeValue: "string",
    extraConfig: {
        string: "string",
    },
    name: "string",
});
Copy
type: keycloak:HardcodedAttributeIdentityProviderMapper
properties:
    attributeName: string
    attributeValue: string
    extraConfig:
        string: string
    identityProviderAlias: string
    name: string
    realm: string
    userSession: false
Copy

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

IdentityProviderAlias
This property is required.
Changes to this property will trigger replacement.
string
The IDP alias of the attribute to set.
Realm
This property is required.
Changes to this property will trigger replacement.
string
The realm ID that this mapper will exist in.
UserSession
This property is required.
Changes to this property will trigger replacement.
bool
Is Attribute related to a User Session.
AttributeName string
The name of the IDP attribute to set.
AttributeValue string
The value to set to the attribute. You can hardcode any value like 'foo'.
ExtraConfig Dictionary<string, string>
Name Changes to this property will trigger replacement. string
Display name of this mapper when displayed in the console.
IdentityProviderAlias
This property is required.
Changes to this property will trigger replacement.
string
The IDP alias of the attribute to set.
Realm
This property is required.
Changes to this property will trigger replacement.
string
The realm ID that this mapper will exist in.
UserSession
This property is required.
Changes to this property will trigger replacement.
bool
Is Attribute related to a User Session.
AttributeName string
The name of the IDP attribute to set.
AttributeValue string
The value to set to the attribute. You can hardcode any value like 'foo'.
ExtraConfig map[string]string
Name Changes to this property will trigger replacement. string
Display name of this mapper when displayed in the console.
identityProviderAlias
This property is required.
Changes to this property will trigger replacement.
String
The IDP alias of the attribute to set.
realm
This property is required.
Changes to this property will trigger replacement.
String
The realm ID that this mapper will exist in.
userSession
This property is required.
Changes to this property will trigger replacement.
Boolean
Is Attribute related to a User Session.
attributeName String
The name of the IDP attribute to set.
attributeValue String
The value to set to the attribute. You can hardcode any value like 'foo'.
extraConfig Map<String,String>
name Changes to this property will trigger replacement. String
Display name of this mapper when displayed in the console.
identityProviderAlias
This property is required.
Changes to this property will trigger replacement.
string
The IDP alias of the attribute to set.
realm
This property is required.
Changes to this property will trigger replacement.
string
The realm ID that this mapper will exist in.
userSession
This property is required.
Changes to this property will trigger replacement.
boolean
Is Attribute related to a User Session.
attributeName string
The name of the IDP attribute to set.
attributeValue string
The value to set to the attribute. You can hardcode any value like 'foo'.
extraConfig {[key: string]: string}
name Changes to this property will trigger replacement. string
Display name of this mapper when displayed in the console.
identity_provider_alias
This property is required.
Changes to this property will trigger replacement.
str
The IDP alias of the attribute to set.
realm
This property is required.
Changes to this property will trigger replacement.
str
The realm ID that this mapper will exist in.
user_session
This property is required.
Changes to this property will trigger replacement.
bool
Is Attribute related to a User Session.
attribute_name str
The name of the IDP attribute to set.
attribute_value str
The value to set to the attribute. You can hardcode any value like 'foo'.
extra_config Mapping[str, str]
name Changes to this property will trigger replacement. str
Display name of this mapper when displayed in the console.
identityProviderAlias
This property is required.
Changes to this property will trigger replacement.
String
The IDP alias of the attribute to set.
realm
This property is required.
Changes to this property will trigger replacement.
String
The realm ID that this mapper will exist in.
userSession
This property is required.
Changes to this property will trigger replacement.
Boolean
Is Attribute related to a User Session.
attributeName String
The name of the IDP attribute to set.
attributeValue String
The value to set to the attribute. You can hardcode any value like 'foo'.
extraConfig Map<String>
name Changes to this property will trigger replacement. String
Display name of this mapper when displayed in the console.

Outputs

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

Get an existing HardcodedAttributeIdentityProviderMapper 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?: HardcodedAttributeIdentityProviderMapperState, opts?: CustomResourceOptions): HardcodedAttributeIdentityProviderMapper
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attribute_name: Optional[str] = None,
        attribute_value: Optional[str] = None,
        extra_config: Optional[Mapping[str, str]] = None,
        identity_provider_alias: Optional[str] = None,
        name: Optional[str] = None,
        realm: Optional[str] = None,
        user_session: Optional[bool] = None) -> HardcodedAttributeIdentityProviderMapper
func GetHardcodedAttributeIdentityProviderMapper(ctx *Context, name string, id IDInput, state *HardcodedAttributeIdentityProviderMapperState, opts ...ResourceOption) (*HardcodedAttributeIdentityProviderMapper, error)
public static HardcodedAttributeIdentityProviderMapper Get(string name, Input<string> id, HardcodedAttributeIdentityProviderMapperState? state, CustomResourceOptions? opts = null)
public static HardcodedAttributeIdentityProviderMapper get(String name, Output<String> id, HardcodedAttributeIdentityProviderMapperState state, CustomResourceOptions options)
resources:  _:    type: keycloak:HardcodedAttributeIdentityProviderMapper    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:
AttributeName string
The name of the IDP attribute to set.
AttributeValue string
The value to set to the attribute. You can hardcode any value like 'foo'.
ExtraConfig Dictionary<string, string>
IdentityProviderAlias Changes to this property will trigger replacement. string
The IDP alias of the attribute to set.
Name Changes to this property will trigger replacement. string
Display name of this mapper when displayed in the console.
Realm Changes to this property will trigger replacement. string
The realm ID that this mapper will exist in.
UserSession Changes to this property will trigger replacement. bool
Is Attribute related to a User Session.
AttributeName string
The name of the IDP attribute to set.
AttributeValue string
The value to set to the attribute. You can hardcode any value like 'foo'.
ExtraConfig map[string]string
IdentityProviderAlias Changes to this property will trigger replacement. string
The IDP alias of the attribute to set.
Name Changes to this property will trigger replacement. string
Display name of this mapper when displayed in the console.
Realm Changes to this property will trigger replacement. string
The realm ID that this mapper will exist in.
UserSession Changes to this property will trigger replacement. bool
Is Attribute related to a User Session.
attributeName String
The name of the IDP attribute to set.
attributeValue String
The value to set to the attribute. You can hardcode any value like 'foo'.
extraConfig Map<String,String>
identityProviderAlias Changes to this property will trigger replacement. String
The IDP alias of the attribute to set.
name Changes to this property will trigger replacement. String
Display name of this mapper when displayed in the console.
realm Changes to this property will trigger replacement. String
The realm ID that this mapper will exist in.
userSession Changes to this property will trigger replacement. Boolean
Is Attribute related to a User Session.
attributeName string
The name of the IDP attribute to set.
attributeValue string
The value to set to the attribute. You can hardcode any value like 'foo'.
extraConfig {[key: string]: string}
identityProviderAlias Changes to this property will trigger replacement. string
The IDP alias of the attribute to set.
name Changes to this property will trigger replacement. string
Display name of this mapper when displayed in the console.
realm Changes to this property will trigger replacement. string
The realm ID that this mapper will exist in.
userSession Changes to this property will trigger replacement. boolean
Is Attribute related to a User Session.
attribute_name str
The name of the IDP attribute to set.
attribute_value str
The value to set to the attribute. You can hardcode any value like 'foo'.
extra_config Mapping[str, str]
identity_provider_alias Changes to this property will trigger replacement. str
The IDP alias of the attribute to set.
name Changes to this property will trigger replacement. str
Display name of this mapper when displayed in the console.
realm Changes to this property will trigger replacement. str
The realm ID that this mapper will exist in.
user_session Changes to this property will trigger replacement. bool
Is Attribute related to a User Session.
attributeName String
The name of the IDP attribute to set.
attributeValue String
The value to set to the attribute. You can hardcode any value like 'foo'.
extraConfig Map<String>
identityProviderAlias Changes to this property will trigger replacement. String
The IDP alias of the attribute to set.
name Changes to this property will trigger replacement. String
Display name of this mapper when displayed in the console.
realm Changes to this property will trigger replacement. String
The realm ID that this mapper will exist in.
userSession Changes to this property will trigger replacement. Boolean
Is Attribute related to a User Session.

Package Details

Repository
Keycloak pulumi/pulumi-keycloak
License
Apache-2.0
Notes
This Pulumi package is based on the keycloak Terraform Provider.