AttributeImporterIdentityProviderMapper

# keycloak..AttributeImporterIdentityProviderMapper

Allows to create and manage identity provider mappers within Keycloak.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as keycloak from "@pulumi/keycloak";

const testMapper = new keycloak.AttributeImporterIdentityProviderMapper("test_mapper", {
    attributeName: "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname",
    identityProviderAlias: "idp_alias",
    realm: "my-realm",
    userAttribute: "lastName",
});

import pulumi
import pulumi_keycloak as keycloak

test_mapper = keycloak.AttributeImporterIdentityProviderMapper("testMapper",
    attribute_name="http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname",
    identity_provider_alias="idp_alias",
    realm="my-realm",
    user_attribute="lastName")

using Pulumi;
using Keycloak = Pulumi.Keycloak;

class MyStack : Stack
{
    public MyStack()
    {
        var testMapper = new Keycloak.AttributeImporterIdentityProviderMapper("testMapper", new Keycloak.AttributeImporterIdentityProviderMapperArgs
        {
            AttributeName = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname",
            IdentityProviderAlias = "idp_alias",
            Realm = "my-realm",
            UserAttribute = "lastName",
        });
    }

}

Argument Reference

The following arguments are supported:

realm - (Required) The name of the realm.
name - (Required) The name of the mapper.
identity_provider_alias - (Required) The alias of the associated identity provider.
user_attribute - (Required) The user attribute name to store SAML attribute.
attribute_name - (Optional) The Name of attribute to search for in assertion. You can leave this blank and specify a friendly name instead.
attribute_friendly_name - (Optional) The friendly name of attribute to search for in assertion. You can leave this blank and specify an attribute name instead.
claim_name - (Optional) The claim name.

Create a AttributeImporterIdentityProviderMapper Resource

new AttributeImporterIdentityProviderMapper(name: string, args: AttributeImporterIdentityProviderMapperArgs, opts?: CustomResourceOptions);

def AttributeImporterIdentityProviderMapper(resource_name, opts=None, attribute_friendly_name=None, attribute_name=None, claim_name=None, identity_provider_alias=None, name=None, realm=None, user_attribute=None, __props__=None);

func NewAttributeImporterIdentityProviderMapper(ctx *Context, name string, args AttributeImporterIdentityProviderMapperArgs, opts ...ResourceOption) (*AttributeImporterIdentityProviderMapper, error)

public AttributeImporterIdentityProviderMapper(string name, AttributeImporterIdentityProviderMapperArgs args, CustomResourceOptions? opts = null)

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

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args AttributeImporterIdentityProviderMapperArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

AttributeImporterIdentityProviderMapper Resource Properties

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

Inputs

The AttributeImporterIdentityProviderMapper resource accepts the following input properties:

IdentityProviderAlias string: IDP Alias
Realm string: Realm Name
UserAttribute string: User Attribute
AttributeFriendlyName string: Attribute Friendly Name
AttributeName string: Attribute Name
ClaimName string: Claim Name
Name string: IDP Mapper Name

IdentityProviderAlias string: IDP Alias
Realm string: Realm Name
UserAttribute string: User Attribute
AttributeFriendlyName string: Attribute Friendly Name
AttributeName string: Attribute Name
ClaimName string: Claim Name
Name string: IDP Mapper Name

identityProviderAlias string: IDP Alias
realm string: Realm Name
userAttribute string: User Attribute
attributeFriendlyName string: Attribute Friendly Name
attributeName string: Attribute Name
claimName string: Claim Name
name string: IDP Mapper Name

identity_provider_alias str: IDP Alias
realm str: Realm Name
user_attribute str: User Attribute
attribute_friendly_name str: Attribute Friendly Name
attribute_name str: Attribute Name
claim_name str: Claim Name
name str: IDP Mapper Name

Outputs

All input properties are implicitly available as output properties. Additionally, the AttributeImporterIdentityProviderMapper 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 str: The provider-assigned unique ID for this managed resource.

Look up an Existing AttributeImporterIdentityProviderMapper Resource

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

static get(resource_name, id, opts=None, attribute_friendly_name=None, attribute_name=None, claim_name=None, identity_provider_alias=None, name=None, realm=None, user_attribute=None, __props__=None);

func GetAttributeImporterIdentityProviderMapper(ctx *Context, name string, id IDInput, state *AttributeImporterIdentityProviderMapperState, opts ...ResourceOption) (*AttributeImporterIdentityProviderMapper, error)

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

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.

The following state arguments are supported:

AttributeFriendlyName string: Attribute Friendly Name
AttributeName string: Attribute Name
ClaimName string: Claim Name
IdentityProviderAlias string: IDP Alias
Name string: IDP Mapper Name
Realm string: Realm Name
UserAttribute string: User Attribute

AttributeFriendlyName string: Attribute Friendly Name
AttributeName string: Attribute Name
ClaimName string: Claim Name
IdentityProviderAlias string: IDP Alias
Name string: IDP Mapper Name
Realm string: Realm Name
UserAttribute string: User Attribute

attributeFriendlyName string: Attribute Friendly Name
attributeName string: Attribute Name
claimName string: Claim Name
identityProviderAlias string: IDP Alias
name string: IDP Mapper Name
realm string: Realm Name
userAttribute string: User Attribute

attribute_friendly_name str: Attribute Friendly Name
attribute_name str: Attribute Name
claim_name str: Claim Name
identity_provider_alias str: IDP Alias
name str: IDP Mapper Name
realm str: Realm Name
user_attribute str: User Attribute

Package Details

Repository: https://github.com/pulumi/pulumi-keycloak
License: Apache-2.0
Notes: This Pulumi package is based on the keycloak Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud