Class AttributeImporterIdentityProviderMapper

# keycloak..AttributeImporterIdentityProviderMapper

Allows to create and manage identity provider mappers within Keycloak.

Example Usage

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.
Inheritance
System.Object
Resource
CustomResource
AttributeImporterIdentityProviderMapper
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Keycloak
Assembly: Pulumi.Keycloak.dll
Syntax
public class AttributeImporterIdentityProviderMapper : CustomResource

Constructors

View Source

AttributeImporterIdentityProviderMapper(String, AttributeImporterIdentityProviderMapperArgs, CustomResourceOptions)

Create a AttributeImporterIdentityProviderMapper resource with the given unique name, arguments, and options.

Declaration
public AttributeImporterIdentityProviderMapper(string name, AttributeImporterIdentityProviderMapperArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource
AttributeImporterIdentityProviderMapperArgs args

The arguments used to populate this resource's properties
CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

AttributeFriendlyName

Attribute Friendly Name

Declaration
public Output<string> AttributeFriendlyName { get; }
Property Value
Type Description
Output<System.String>
View Source

AttributeName

Attribute Name

Declaration
public Output<string> AttributeName { get; }
Property Value
Type Description
Output<System.String>
View Source

ClaimName

Claim Name

Declaration
public Output<string> ClaimName { get; }
Property Value
Type Description
Output<System.String>
View Source

IdentityProviderAlias

IDP Alias

Declaration
public Output<string> IdentityProviderAlias { get; }
Property Value
Type Description
Output<System.String>
View Source

Name

IDP Mapper Name

Declaration
public Output<string> Name { get; }
Property Value
Type Description
Output<System.String>
View Source

Realm

Realm Name

Declaration
public Output<string> Realm { get; }
Property Value
Type Description
Output<System.String>
View Source

UserAttribute

User Attribute

Declaration
public Output<string> UserAttribute { get; }
Property Value
Type Description
Output<System.String>

Methods

View Source

Get(String, Input<String>, AttributeImporterIdentityProviderMapperState, CustomResourceOptions)

Get an existing AttributeImporterIdentityProviderMapper resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration
public static AttributeImporterIdentityProviderMapper Get(string name, Input<string> id, AttributeImporterIdentityProviderMapperState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.
Input<System.String> id

The unique provider ID of the resource to lookup.
AttributeImporterIdentityProviderMapperState state

Any extra arguments used during the lookup.
CustomResourceOptions options

A bag of options that control this resource's behavior
Returns
Type Description
AttributeImporterIdentityProviderMapper