keycloak.AttributeToRoleIdentityMapper (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 AttributeToRoleIdentityMapper Resource

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

Constructor syntax

new AttributeToRoleIdentityMapper(name: string, args: AttributeToRoleIdentityMapperArgs, opts?: CustomResourceOptions);

@overload
def AttributeToRoleIdentityMapper(resource_name: str,
                                  args: AttributeToRoleIdentityMapperArgs,
                                  opts: Optional[ResourceOptions] = None)

@overload
def AttributeToRoleIdentityMapper(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  identity_provider_alias: Optional[str] = None,
                                  realm: Optional[str] = None,
                                  role: Optional[str] = None,
                                  attribute_friendly_name: Optional[str] = None,
                                  attribute_name: Optional[str] = None,
                                  attribute_value: Optional[str] = None,
                                  claim_name: Optional[str] = None,
                                  claim_value: Optional[str] = None,
                                  extra_config: Optional[Mapping[str, Any]] = None,
                                  name: Optional[str] = None)

func NewAttributeToRoleIdentityMapper(ctx *Context, name string, args AttributeToRoleIdentityMapperArgs, opts ...ResourceOption) (*AttributeToRoleIdentityMapper, error)

public AttributeToRoleIdentityMapper(string name, AttributeToRoleIdentityMapperArgs args, CustomResourceOptions? opts = null)

public AttributeToRoleIdentityMapper(String name, AttributeToRoleIdentityMapperArgs args)
public AttributeToRoleIdentityMapper(String name, AttributeToRoleIdentityMapperArgs args, CustomResourceOptions options)

type: keycloak:AttributeToRoleIdentityMapper
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 AttributeToRoleIdentityMapperArgs: 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 AttributeToRoleIdentityMapperArgs: 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 AttributeToRoleIdentityMapperArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args AttributeToRoleIdentityMapperArgs: 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 attributeToRoleIdentityMapperResource = new Keycloak.AttributeToRoleIdentityMapper("attributeToRoleIdentityMapperResource", new()
{
    IdentityProviderAlias = "string",
    Realm = "string",
    Role = "string",
    AttributeFriendlyName = "string",
    AttributeName = "string",
    AttributeValue = "string",
    ClaimName = "string",
    ClaimValue = "string",
    ExtraConfig = 
    {
        { "string", "any" },
    },
    Name = "string",
});

example, err := keycloak.NewAttributeToRoleIdentityMapper(ctx, "attributeToRoleIdentityMapperResource", &keycloak.AttributeToRoleIdentityMapperArgs{
	IdentityProviderAlias: pulumi.String("string"),
	Realm:                 pulumi.String("string"),
	Role:                  pulumi.String("string"),
	AttributeFriendlyName: pulumi.String("string"),
	AttributeName:         pulumi.String("string"),
	AttributeValue:        pulumi.String("string"),
	ClaimName:             pulumi.String("string"),
	ClaimValue:            pulumi.String("string"),
	ExtraConfig: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	Name: pulumi.String("string"),
})

var attributeToRoleIdentityMapperResource = new AttributeToRoleIdentityMapper("attributeToRoleIdentityMapperResource", AttributeToRoleIdentityMapperArgs.builder()
    .identityProviderAlias("string")
    .realm("string")
    .role("string")
    .attributeFriendlyName("string")
    .attributeName("string")
    .attributeValue("string")
    .claimName("string")
    .claimValue("string")
    .extraConfig(Map.of("string", "any"))
    .name("string")
    .build());

attribute_to_role_identity_mapper_resource = keycloak.AttributeToRoleIdentityMapper("attributeToRoleIdentityMapperResource",
    identity_provider_alias="string",
    realm="string",
    role="string",
    attribute_friendly_name="string",
    attribute_name="string",
    attribute_value="string",
    claim_name="string",
    claim_value="string",
    extra_config={
        "string": "any",
    },
    name="string")

const attributeToRoleIdentityMapperResource = new keycloak.AttributeToRoleIdentityMapper("attributeToRoleIdentityMapperResource", {
    identityProviderAlias: "string",
    realm: "string",
    role: "string",
    attributeFriendlyName: "string",
    attributeName: "string",
    attributeValue: "string",
    claimName: "string",
    claimValue: "string",
    extraConfig: {
        string: "any",
    },
    name: "string",
});

type: keycloak:AttributeToRoleIdentityMapper
properties:
    attributeFriendlyName: string
    attributeName: string
    attributeValue: string
    claimName: string
    claimValue: string
    extraConfig:
        string: any
    identityProviderAlias: string
    name: string
    realm: string
    role: string

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

IdentityProviderAlias string: IDP Alias
Realm string: Realm Name
Role string: Role Name
AttributeFriendlyName string: Attribute Friendly Name
AttributeName string: Attribute Name
AttributeValue string: Attribute Value
ClaimName string: OIDC Claim Name
ClaimValue string: OIDC Claim Value
ExtraConfig Dictionary<string, object>
Name string: IDP Mapper Name

IdentityProviderAlias string: IDP Alias
Realm string: Realm Name
Role string: Role Name
AttributeFriendlyName string: Attribute Friendly Name
AttributeName string: Attribute Name
AttributeValue string: Attribute Value
ClaimName string: OIDC Claim Name
ClaimValue string: OIDC Claim Value
ExtraConfig map[string]interface{}
Name string: IDP Mapper Name

identityProviderAlias String: IDP Alias
realm String: Realm Name
role String: Role Name
attributeFriendlyName String: Attribute Friendly Name
attributeName String: Attribute Name
attributeValue String: Attribute Value
claimName String: OIDC Claim Name
claimValue String: OIDC Claim Value
extraConfig Map<String,Object>
name String: IDP Mapper Name

identityProviderAlias string: IDP Alias
realm string: Realm Name
role string: Role Name
attributeFriendlyName string: Attribute Friendly Name
attributeName string: Attribute Name
attributeValue string: Attribute Value
claimName string: OIDC Claim Name
claimValue string: OIDC Claim Value
extraConfig {[key: string]: any}
name string: IDP Mapper Name

identity_provider_alias str: IDP Alias
realm str: Realm Name
role str: Role Name
attribute_friendly_name str: Attribute Friendly Name
attribute_name str: Attribute Name
attribute_value str: Attribute Value
claim_name str: OIDC Claim Name
claim_value str: OIDC Claim Value
extra_config Mapping[str, Any]
name str: IDP Mapper Name

identityProviderAlias String: IDP Alias
realm String: Realm Name
role String: Role Name
attributeFriendlyName String: Attribute Friendly Name
attributeName String: Attribute Name
attributeValue String: Attribute Value
claimName String: OIDC Claim Name
claimValue String: OIDC Claim Value
extraConfig Map<Any>
name String: IDP Mapper Name

Outputs

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

Get an existing AttributeToRoleIdentityMapper 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?: AttributeToRoleIdentityMapperState, opts?: CustomResourceOptions): AttributeToRoleIdentityMapper

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attribute_friendly_name: Optional[str] = None,
        attribute_name: Optional[str] = None,
        attribute_value: Optional[str] = None,
        claim_name: Optional[str] = None,
        claim_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,
        role: Optional[str] = None) -> AttributeToRoleIdentityMapper

func GetAttributeToRoleIdentityMapper(ctx *Context, name string, id IDInput, state *AttributeToRoleIdentityMapperState, opts ...ResourceOption) (*AttributeToRoleIdentityMapper, error)

public static AttributeToRoleIdentityMapper Get(string name, Input<string> id, AttributeToRoleIdentityMapperState? state, CustomResourceOptions? opts = null)

public static AttributeToRoleIdentityMapper get(String name, Output<String> id, AttributeToRoleIdentityMapperState state, CustomResourceOptions options)

resources:  _:    type: keycloak:AttributeToRoleIdentityMapper    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:

AttributeFriendlyName string: Attribute Friendly Name
AttributeName string: Attribute Name
AttributeValue string: Attribute Value
ClaimName string: OIDC Claim Name
ClaimValue string: OIDC Claim Value
ExtraConfig Dictionary<string, object>
IdentityProviderAlias string: IDP Alias
Name string: IDP Mapper Name
Realm string: Realm Name
Role string: Role Name

AttributeFriendlyName string: Attribute Friendly Name
AttributeName string: Attribute Name
AttributeValue string: Attribute Value
ClaimName string: OIDC Claim Name
ClaimValue string: OIDC Claim Value
ExtraConfig map[string]interface{}
IdentityProviderAlias string: IDP Alias
Name string: IDP Mapper Name
Realm string: Realm Name
Role string: Role Name

attributeFriendlyName String: Attribute Friendly Name
attributeName String: Attribute Name
attributeValue String: Attribute Value
claimName String: OIDC Claim Name
claimValue String: OIDC Claim Value
extraConfig Map<String,Object>
identityProviderAlias String: IDP Alias
name String: IDP Mapper Name
realm String: Realm Name
role String: Role Name

attributeFriendlyName string: Attribute Friendly Name
attributeName string: Attribute Name
attributeValue string: Attribute Value
claimName string: OIDC Claim Name
claimValue string: OIDC Claim Value
extraConfig {[key: string]: any}
identityProviderAlias string: IDP Alias
name string: IDP Mapper Name
realm string: Realm Name
role string: Role Name

attribute_friendly_name str: Attribute Friendly Name
attribute_name str: Attribute Name
attribute_value str: Attribute Value
claim_name str: OIDC Claim Name
claim_value str: OIDC Claim Value
extra_config Mapping[str, Any]
identity_provider_alias str: IDP Alias
name str: IDP Mapper Name
realm str: Realm Name
role str: Role Name

attributeFriendlyName String: Attribute Friendly Name
attributeName String: Attribute Name
attributeValue String: Attribute Value
claimName String: OIDC Claim Name
claimValue String: OIDC Claim Value
extraConfig Map<Any>
identityProviderAlias String: IDP Alias
name String: IDP Mapper Name
realm String: Realm Name
role String: Role Name

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.AttributeToRoleIdentityMapper

On this page

On this page

Create AttributeToRoleIdentityMapper Resource

Constructor syntax

Parameters

Constructor example

AttributeToRoleIdentityMapper Resource Properties

Inputs

Outputs

Look up Existing AttributeToRoleIdentityMapper Resource

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

keycloak.AttributeToRoleIdentityMapper

On this page

On this page

Create AttributeToRoleIdentityMapper Resource

Constructor syntax

Parameters

Constructor example

AttributeToRoleIdentityMapper Resource Properties

Inputs

Outputs

Look up Existing AttributeToRoleIdentityMapper Resource

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.