keycloak.HardcodedAttributeIdentityProviderMapper (v4)

Keycloak v4.11.0 (4.x), Mar 9 26

Viewing docs for Keycloak v4.11.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-keycloak

Viewing docs for Keycloak v4.11.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-keycloak

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, Any]] = 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 string: The unique name of the resource.
args HardcodedAttributeIdentityProviderMapperArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args 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 string: The unique name of the resource.
args HardcodedAttributeIdentityProviderMapperArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args HardcodedAttributeIdentityProviderMapperArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args 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", "any" },
    },
    Name = "string",
});

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.Map{
		"string": pulumi.Any("any"),
	},
	Name: pulumi.String("string"),
})

var hardcodedAttributeIdentityProviderMapperResource = new HardcodedAttributeIdentityProviderMapper("hardcodedAttributeIdentityProviderMapperResource", HardcodedAttributeIdentityProviderMapperArgs.builder()
    .identityProviderAlias("string")
    .realm("string")
    .userSession(false)
    .attributeName("string")
    .attributeValue("string")
    .extraConfig(Map.of("string", "any"))
    .name("string")
    .build());

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": "any",
    },
    name="string")

const hardcodedAttributeIdentityProviderMapperResource = new keycloak.HardcodedAttributeIdentityProviderMapper("hardcodedAttributeIdentityProviderMapperResource", {
    identityProviderAlias: "string",
    realm: "string",
    userSession: false,
    attributeName: "string",
    attributeValue: "string",
    extraConfig: {
        string: "any",
    },
    name: "string",
});

type: keycloak:HardcodedAttributeIdentityProviderMapper
properties:
    attributeName: string
    attributeValue: string
    extraConfig:
        string: any
    identityProviderAlias: string
    name: string
    realm: string
    userSession: false

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 string: IDP Alias
Realm string: Realm Name
UserSession bool: Is Attribute Related To a User Session
AttributeName string: OIDC Claim
AttributeValue string: User Attribute
ExtraConfig Dictionary<string, object>
Name string: IDP Mapper Name

IdentityProviderAlias string: IDP Alias
Realm string: Realm Name
UserSession bool: Is Attribute Related To a User Session
AttributeName string: OIDC Claim
AttributeValue string: User Attribute
ExtraConfig map[string]interface{}
Name string: IDP Mapper Name

identityProviderAlias String: IDP Alias
realm String: Realm Name
userSession Boolean: Is Attribute Related To a User Session
attributeName String: OIDC Claim
attributeValue String: User Attribute
extraConfig Map<String,Object>
name String: IDP Mapper Name

identityProviderAlias string: IDP Alias
realm string: Realm Name
userSession boolean: Is Attribute Related To a User Session
attributeName string: OIDC Claim
attributeValue string: User Attribute
extraConfig {[key: string]: any}
name string: IDP Mapper Name

identity_provider_alias str: IDP Alias
realm str: Realm Name
user_session bool: Is Attribute Related To a User Session
attribute_name str: OIDC Claim
attribute_value str: User Attribute
extra_config Mapping[str, Any]
name str: IDP Mapper Name

identityProviderAlias String: IDP Alias
realm String: Realm Name
userSession Boolean: Is Attribute Related To a User Session
attributeName String: OIDC Claim
attributeValue String: User Attribute
extraConfig Map<Any>
name String: IDP Mapper Name

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, Any]] = 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: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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: OIDC Claim
AttributeValue string: User Attribute
ExtraConfig Dictionary<string, object>
IdentityProviderAlias string: IDP Alias
Name string: IDP Mapper Name
Realm string: Realm Name
UserSession bool: Is Attribute Related To a User Session

AttributeName string: OIDC Claim
AttributeValue string: User Attribute
ExtraConfig map[string]interface{}
IdentityProviderAlias string: IDP Alias
Name string: IDP Mapper Name
Realm string: Realm Name
UserSession bool: Is Attribute Related To a User Session

attributeName String: OIDC Claim
attributeValue String: User Attribute
extraConfig Map<String,Object>
identityProviderAlias String: IDP Alias
name String: IDP Mapper Name
realm String: Realm Name
userSession Boolean: Is Attribute Related To a User Session

attributeName string: OIDC Claim
attributeValue string: User Attribute
extraConfig {[key: string]: any}
identityProviderAlias string: IDP Alias
name string: IDP Mapper Name
realm string: Realm Name
userSession boolean: Is Attribute Related To a User Session

attribute_name str: OIDC Claim
attribute_value str: User Attribute
extra_config Mapping[str, Any]
identity_provider_alias str: IDP Alias
name str: IDP Mapper Name
realm str: Realm Name
user_session bool: Is Attribute Related To a User Session

attributeName String: OIDC Claim
attributeValue String: User Attribute
extraConfig Map<Any>
identityProviderAlias String: IDP Alias
name String: IDP Mapper Name
realm String: Realm Name
userSession 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.

Viewing docs for Keycloak v4.11.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-keycloak

keycloak.HardcodedAttributeIdentityProviderMapper

On this page

On this page

Create HardcodedAttributeIdentityProviderMapper Resource

Constructor syntax

Parameters

Constructor example

HardcodedAttributeIdentityProviderMapper Resource Properties

Inputs

Outputs

Look up Existing HardcodedAttributeIdentityProviderMapper Resource

Package Details

On this page

On this page