Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Keycloak Provider
  3. API Docs
  4. HardcodedGroupIdentityProviderMapper
Keycloak v6.4.0 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-keycloak

keycloak.HardcodedGroupIdentityProviderMapper

Explore with Pulumi AI

keycloak logo
Keycloak v6.4.0 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-keycloak

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

    The identity provider hardcoded group mapper grants a specified Keycloak group to each Keycloak user from the identity provider.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    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
  realmGroup:
    type: keycloak:Group
    name: realm_group
    properties:
      realmId: ${realm.id}
      name: my-realm-group
      description: My Realm Group
  oidcHardcodedGroupIdentityProviderMapper:
    type: keycloak:HardcodedGroupIdentityProviderMapper
    name: oidc
    properties:
      realm: ${realm.id}
      name: hardcodedGroup
      identityProviderAlias: ${oidc.alias}
      group: my-realm-group
      extraConfig:
        syncMode: INHERIT

    Create HardcodedGroupIdentityProviderMapper Resource

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

    Constructor syntax

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

@overload
def HardcodedGroupIdentityProviderMapper(resource_name: str,
                                         opts: Optional[ResourceOptions] = None,
                                         identity_provider_alias: Optional[str] = None,
                                         realm: Optional[str] = None,
                                         extra_config: Optional[Mapping[str, str]] = None,
                                         group: Optional[str] = None,
                                         name: Optional[str] = None)
    func NewHardcodedGroupIdentityProviderMapper(ctx *Context, name string, args HardcodedGroupIdentityProviderMapperArgs, opts ...ResourceOption) (*HardcodedGroupIdentityProviderMapper, error)
    public HardcodedGroupIdentityProviderMapper(string name, HardcodedGroupIdentityProviderMapperArgs args, CustomResourceOptions? opts = null)
    public HardcodedGroupIdentityProviderMapper(String name, HardcodedGroupIdentityProviderMapperArgs args)
public HardcodedGroupIdentityProviderMapper(String name, HardcodedGroupIdentityProviderMapperArgs args, CustomResourceOptions options)

    type: keycloak:HardcodedGroupIdentityProviderMapper
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 HardcodedGroupIdentityProviderMapperArgs
    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 HardcodedGroupIdentityProviderMapperArgs
    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 HardcodedGroupIdentityProviderMapperArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HardcodedGroupIdentityProviderMapperArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HardcodedGroupIdentityProviderMapperArgs
    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 hardcodedGroupIdentityProviderMapperResource = new Keycloak.HardcodedGroupIdentityProviderMapper("hardcodedGroupIdentityProviderMapperResource", new()
{
    IdentityProviderAlias = "string",
    Realm = "string",
    ExtraConfig = 
    {
        { "string", "string" },
    },
    Group = "string",
    Name = "string",
});

    example, err := keycloak.NewHardcodedGroupIdentityProviderMapper(ctx, "hardcodedGroupIdentityProviderMapperResource", &keycloak.HardcodedGroupIdentityProviderMapperArgs{
	IdentityProviderAlias: pulumi.String("string"),
	Realm:                 pulumi.String("string"),
	ExtraConfig: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Group: pulumi.String("string"),
	Name:  pulumi.String("string"),
})

    var hardcodedGroupIdentityProviderMapperResource = new HardcodedGroupIdentityProviderMapper("hardcodedGroupIdentityProviderMapperResource", HardcodedGroupIdentityProviderMapperArgs.builder()
    .identityProviderAlias("string")
    .realm("string")
    .extraConfig(Map.of("string", "string"))
    .group("string")
    .name("string")
    .build());

    hardcoded_group_identity_provider_mapper_resource = keycloak.HardcodedGroupIdentityProviderMapper("hardcodedGroupIdentityProviderMapperResource",
    identity_provider_alias="string",
    realm="string",
    extra_config={
        "string": "string",
    },
    group="string",
    name="string")

    const hardcodedGroupIdentityProviderMapperResource = new keycloak.HardcodedGroupIdentityProviderMapper("hardcodedGroupIdentityProviderMapperResource", {
    identityProviderAlias: "string",
    realm: "string",
    extraConfig: {
        string: "string",
    },
    group: "string",
    name: "string",
});

    type: keycloak:HardcodedGroupIdentityProviderMapper
properties:
    extraConfig:
        string: string
    group: string
    identityProviderAlias: string
    name: string
    realm: string

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

    IdentityProviderAlias string
    The IDP alias of the attribute to set.
    Realm string
    The realm ID that this mapper will exist in.
    ExtraConfig Dictionary<string, string>
    Group string
    The name of the group which should be assigned to the users.
    Name string
    Display name of this mapper when displayed in the console.
    IdentityProviderAlias string
    The IDP alias of the attribute to set.
    Realm string
    The realm ID that this mapper will exist in.
    ExtraConfig map[string]string
    Group string
    The name of the group which should be assigned to the users.
    Name string
    Display name of this mapper when displayed in the console.
    identityProviderAlias String
    The IDP alias of the attribute to set.
    realm String
    The realm ID that this mapper will exist in.
    extraConfig Map<String,String>
    group String
    The name of the group which should be assigned to the users.
    name String
    Display name of this mapper when displayed in the console.
    identityProviderAlias string
    The IDP alias of the attribute to set.
    realm string
    The realm ID that this mapper will exist in.
    extraConfig {[key: string]: string}
    group string
    The name of the group which should be assigned to the users.
    name string
    Display name of this mapper when displayed in the console.
    identity_provider_alias str
    The IDP alias of the attribute to set.
    realm str
    The realm ID that this mapper will exist in.
    extra_config Mapping[str, str]
    group str
    The name of the group which should be assigned to the users.
    name str
    Display name of this mapper when displayed in the console.
    identityProviderAlias String
    The IDP alias of the attribute to set.
    realm String
    The realm ID that this mapper will exist in.
    extraConfig Map<String>
    group String
    The name of the group which should be assigned to the users.
    name String
    Display name of this mapper when displayed in the console.

    Outputs

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

    Get an existing HardcodedGroupIdentityProviderMapper 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?: HardcodedGroupIdentityProviderMapperState, opts?: CustomResourceOptions): HardcodedGroupIdentityProviderMapper
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        extra_config: Optional[Mapping[str, str]] = None,
        group: Optional[str] = None,
        identity_provider_alias: Optional[str] = None,
        name: Optional[str] = None,
        realm: Optional[str] = None) -> HardcodedGroupIdentityProviderMapper
    func GetHardcodedGroupIdentityProviderMapper(ctx *Context, name string, id IDInput, state *HardcodedGroupIdentityProviderMapperState, opts ...ResourceOption) (*HardcodedGroupIdentityProviderMapper, error)
    public static HardcodedGroupIdentityProviderMapper Get(string name, Input<string> id, HardcodedGroupIdentityProviderMapperState? state, CustomResourceOptions? opts = null)
    public static HardcodedGroupIdentityProviderMapper get(String name, Output<String> id, HardcodedGroupIdentityProviderMapperState state, CustomResourceOptions options)
    resources:  _:    type: keycloak:HardcodedGroupIdentityProviderMapper    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:
    ExtraConfig Dictionary<string, string>
    Group string
    The name of the group which should be assigned to the users.
    IdentityProviderAlias string
    The IDP alias of the attribute to set.
    Name string
    Display name of this mapper when displayed in the console.
    Realm string
    The realm ID that this mapper will exist in.
    ExtraConfig map[string]string
    Group string
    The name of the group which should be assigned to the users.
    IdentityProviderAlias string
    The IDP alias of the attribute to set.
    Name string
    Display name of this mapper when displayed in the console.
    Realm string
    The realm ID that this mapper will exist in.
    extraConfig Map<String,String>
    group String
    The name of the group which should be assigned to the users.
    identityProviderAlias String
    The IDP alias of the attribute to set.
    name String
    Display name of this mapper when displayed in the console.
    realm String
    The realm ID that this mapper will exist in.
    extraConfig {[key: string]: string}
    group string
    The name of the group which should be assigned to the users.
    identityProviderAlias string
    The IDP alias of the attribute to set.
    name string
    Display name of this mapper when displayed in the console.
    realm string
    The realm ID that this mapper will exist in.
    extra_config Mapping[str, str]
    group str
    The name of the group which should be assigned to the users.
    identity_provider_alias str
    The IDP alias of the attribute to set.
    name str
    Display name of this mapper when displayed in the console.
    realm str
    The realm ID that this mapper will exist in.
    extraConfig Map<String>
    group String
    The name of the group which should be assigned to the users.
    identityProviderAlias String
    The IDP alias of the attribute to set.
    name String
    Display name of this mapper when displayed in the console.
    realm String
    The realm ID that this mapper will exist in.

    Package Details

    Repository
    Keycloak pulumi/pulumi-keycloak
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the keycloak Terraform Provider.
    keycloak logo
    Keycloak v6.4.0 published on Wednesday, Apr 16, 2025 by Pulumi
    pulumi/pulumi-keycloak