Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Keycloak Provider
  3. API Docs
  4. openid
  5. UserPropertyProtocolMapper
Keycloak v6.1.0 published on Friday, Jan 17, 2025 by Pulumi
pulumi/pulumi-keycloak

keycloak.openid.UserPropertyProtocolMapper

Explore with Pulumi AI

keycloak logo
Keycloak v6.1.0 published on Friday, Jan 17, 2025 by Pulumi
pulumi/pulumi-keycloak

    Allows for creating and managing user property protocol mappers within Keycloak.

    User property protocol mappers allow you to map built in properties defined on the Keycloak user interface to a claim in a token.

    Protocol mappers can be defined for a single client, or they can be defined for a client scope which can be shared between multiple different clients.

    Example Usage

    Client)

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

const realm = new keycloak.Realm("realm", {
    realm: "my-realm",
    enabled: true,
});
const openidClient = new keycloak.openid.Client("openid_client", {
    realmId: realm.id,
    clientId: "client",
    name: "client",
    enabled: true,
    accessType: "CONFIDENTIAL",
    validRedirectUris: ["http://localhost:8080/openid-callback"],
});
const userPropertyMapper = new keycloak.openid.UserPropertyProtocolMapper("user_property_mapper", {
    realmId: realm.id,
    clientId: openidClient.id,
    name: "user-property-mapper",
    userProperty: "email",
    claimName: "email",
});

    import pulumi
import pulumi_keycloak as keycloak

realm = keycloak.Realm("realm",
    realm="my-realm",
    enabled=True)
openid_client = keycloak.openid.Client("openid_client",
    realm_id=realm.id,
    client_id="client",
    name="client",
    enabled=True,
    access_type="CONFIDENTIAL",
    valid_redirect_uris=["http://localhost:8080/openid-callback"])
user_property_mapper = keycloak.openid.UserPropertyProtocolMapper("user_property_mapper",
    realm_id=realm.id,
    client_id=openid_client.id,
    name="user-property-mapper",
    user_property="email",
    claim_name="email")

    package main

import (
	"github.com/pulumi/pulumi-keycloak/sdk/v6/go/keycloak"
	"github.com/pulumi/pulumi-keycloak/sdk/v6/go/keycloak/openid"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		realm, err := keycloak.NewRealm(ctx, "realm", &keycloak.RealmArgs{
			Realm:   pulumi.String("my-realm"),
			Enabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		openidClient, err := openid.NewClient(ctx, "openid_client", &openid.ClientArgs{
			RealmId:    realm.ID(),
			ClientId:   pulumi.String("client"),
			Name:       pulumi.String("client"),
			Enabled:    pulumi.Bool(true),
			AccessType: pulumi.String("CONFIDENTIAL"),
			ValidRedirectUris: pulumi.StringArray{
				pulumi.String("http://localhost:8080/openid-callback"),
			},
		})
		if err != nil {
			return err
		}
		_, err = openid.NewUserPropertyProtocolMapper(ctx, "user_property_mapper", &openid.UserPropertyProtocolMapperArgs{
			RealmId:      realm.ID(),
			ClientId:     openidClient.ID(),
			Name:         pulumi.String("user-property-mapper"),
			UserProperty: pulumi.String("email"),
			ClaimName:    pulumi.String("email"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Keycloak = Pulumi.Keycloak;

return await Deployment.RunAsync(() => 
{
    var realm = new Keycloak.Realm("realm", new()
    {
        RealmName = "my-realm",
        Enabled = true,
    });

    var openidClient = new Keycloak.OpenId.Client("openid_client", new()
    {
        RealmId = realm.Id,
        ClientId = "client",
        Name = "client",
        Enabled = true,
        AccessType = "CONFIDENTIAL",
        ValidRedirectUris = new[]
        {
            "http://localhost:8080/openid-callback",
        },
    });

    var userPropertyMapper = new Keycloak.OpenId.UserPropertyProtocolMapper("user_property_mapper", new()
    {
        RealmId = realm.Id,
        ClientId = openidClient.Id,
        Name = "user-property-mapper",
        UserProperty = "email",
        ClaimName = "email",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.keycloak.Realm;
import com.pulumi.keycloak.RealmArgs;
import com.pulumi.keycloak.openid.Client;
import com.pulumi.keycloak.openid.ClientArgs;
import com.pulumi.keycloak.openid.UserPropertyProtocolMapper;
import com.pulumi.keycloak.openid.UserPropertyProtocolMapperArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var realm = new Realm("realm", RealmArgs.builder()
            .realm("my-realm")
            .enabled(true)
            .build());

        var openidClient = new Client("openidClient", ClientArgs.builder()
            .realmId(realm.id())
            .clientId("client")
            .name("client")
            .enabled(true)
            .accessType("CONFIDENTIAL")
            .validRedirectUris("http://localhost:8080/openid-callback")
            .build());

        var userPropertyMapper = new UserPropertyProtocolMapper("userPropertyMapper", UserPropertyProtocolMapperArgs.builder()
            .realmId(realm.id())
            .clientId(openidClient.id())
            .name("user-property-mapper")
            .userProperty("email")
            .claimName("email")
            .build());

    }
}

    resources:
  realm:
    type: keycloak:Realm
    properties:
      realm: my-realm
      enabled: true
  openidClient:
    type: keycloak:openid:Client
    name: openid_client
    properties:
      realmId: ${realm.id}
      clientId: client
      name: client
      enabled: true
      accessType: CONFIDENTIAL
      validRedirectUris:
        - http://localhost:8080/openid-callback
  userPropertyMapper:
    type: keycloak:openid:UserPropertyProtocolMapper
    name: user_property_mapper
    properties:
      realmId: ${realm.id}
      clientId: ${openidClient.id}
      name: user-property-mapper
      userProperty: email
      claimName: email

    Client Scope)

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

const realm = new keycloak.Realm("realm", {
    realm: "my-realm",
    enabled: true,
});
const clientScope = new keycloak.openid.ClientScope("client_scope", {
    realmId: realm.id,
    name: "client-scope",
});
const userPropertyMapper = new keycloak.openid.UserPropertyProtocolMapper("user_property_mapper", {
    realmId: realm.id,
    clientScopeId: clientScope.id,
    name: "test-mapper",
    userProperty: "email",
    claimName: "email",
});

    import pulumi
import pulumi_keycloak as keycloak

realm = keycloak.Realm("realm",
    realm="my-realm",
    enabled=True)
client_scope = keycloak.openid.ClientScope("client_scope",
    realm_id=realm.id,
    name="client-scope")
user_property_mapper = keycloak.openid.UserPropertyProtocolMapper("user_property_mapper",
    realm_id=realm.id,
    client_scope_id=client_scope.id,
    name="test-mapper",
    user_property="email",
    claim_name="email")

    package main

import (
	"github.com/pulumi/pulumi-keycloak/sdk/v6/go/keycloak"
	"github.com/pulumi/pulumi-keycloak/sdk/v6/go/keycloak/openid"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		realm, err := keycloak.NewRealm(ctx, "realm", &keycloak.RealmArgs{
			Realm:   pulumi.String("my-realm"),
			Enabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		clientScope, err := openid.NewClientScope(ctx, "client_scope", &openid.ClientScopeArgs{
			RealmId: realm.ID(),
			Name:    pulumi.String("client-scope"),
		})
		if err != nil {
			return err
		}
		_, err = openid.NewUserPropertyProtocolMapper(ctx, "user_property_mapper", &openid.UserPropertyProtocolMapperArgs{
			RealmId:       realm.ID(),
			ClientScopeId: clientScope.ID(),
			Name:          pulumi.String("test-mapper"),
			UserProperty:  pulumi.String("email"),
			ClaimName:     pulumi.String("email"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Keycloak = Pulumi.Keycloak;

return await Deployment.RunAsync(() => 
{
    var realm = new Keycloak.Realm("realm", new()
    {
        RealmName = "my-realm",
        Enabled = true,
    });

    var clientScope = new Keycloak.OpenId.ClientScope("client_scope", new()
    {
        RealmId = realm.Id,
        Name = "client-scope",
    });

    var userPropertyMapper = new Keycloak.OpenId.UserPropertyProtocolMapper("user_property_mapper", new()
    {
        RealmId = realm.Id,
        ClientScopeId = clientScope.Id,
        Name = "test-mapper",
        UserProperty = "email",
        ClaimName = "email",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.keycloak.Realm;
import com.pulumi.keycloak.RealmArgs;
import com.pulumi.keycloak.openid.ClientScope;
import com.pulumi.keycloak.openid.ClientScopeArgs;
import com.pulumi.keycloak.openid.UserPropertyProtocolMapper;
import com.pulumi.keycloak.openid.UserPropertyProtocolMapperArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var realm = new Realm("realm", RealmArgs.builder()
            .realm("my-realm")
            .enabled(true)
            .build());

        var clientScope = new ClientScope("clientScope", ClientScopeArgs.builder()
            .realmId(realm.id())
            .name("client-scope")
            .build());

        var userPropertyMapper = new UserPropertyProtocolMapper("userPropertyMapper", UserPropertyProtocolMapperArgs.builder()
            .realmId(realm.id())
            .clientScopeId(clientScope.id())
            .name("test-mapper")
            .userProperty("email")
            .claimName("email")
            .build());

    }
}

    resources:
  realm:
    type: keycloak:Realm
    properties:
      realm: my-realm
      enabled: true
  clientScope:
    type: keycloak:openid:ClientScope
    name: client_scope
    properties:
      realmId: ${realm.id}
      name: client-scope
  userPropertyMapper:
    type: keycloak:openid:UserPropertyProtocolMapper
    name: user_property_mapper
    properties:
      realmId: ${realm.id}
      clientScopeId: ${clientScope.id}
      name: test-mapper
      userProperty: email
      claimName: email

    Create UserPropertyProtocolMapper Resource

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

    Constructor syntax

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

@overload
def UserPropertyProtocolMapper(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               claim_name: Optional[str] = None,
                               realm_id: Optional[str] = None,
                               user_property: Optional[str] = None,
                               add_to_access_token: Optional[bool] = None,
                               add_to_id_token: Optional[bool] = None,
                               add_to_userinfo: Optional[bool] = None,
                               claim_value_type: Optional[str] = None,
                               client_id: Optional[str] = None,
                               client_scope_id: Optional[str] = None,
                               name: Optional[str] = None)
    func NewUserPropertyProtocolMapper(ctx *Context, name string, args UserPropertyProtocolMapperArgs, opts ...ResourceOption) (*UserPropertyProtocolMapper, error)
    public UserPropertyProtocolMapper(string name, UserPropertyProtocolMapperArgs args, CustomResourceOptions? opts = null)
    public UserPropertyProtocolMapper(String name, UserPropertyProtocolMapperArgs args)
public UserPropertyProtocolMapper(String name, UserPropertyProtocolMapperArgs args, CustomResourceOptions options)

    type: keycloak:openid:UserPropertyProtocolMapper
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 UserPropertyProtocolMapperArgs
    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 UserPropertyProtocolMapperArgs
    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 UserPropertyProtocolMapperArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserPropertyProtocolMapperArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserPropertyProtocolMapperArgs
    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 userPropertyProtocolMapperResource = new Keycloak.OpenId.UserPropertyProtocolMapper("userPropertyProtocolMapperResource", new()
{
    ClaimName = "string",
    RealmId = "string",
    UserProperty = "string",
    AddToAccessToken = false,
    AddToIdToken = false,
    AddToUserinfo = false,
    ClaimValueType = "string",
    ClientId = "string",
    ClientScopeId = "string",
    Name = "string",
});

    example, err := openid.NewUserPropertyProtocolMapper(ctx, "userPropertyProtocolMapperResource", &openid.UserPropertyProtocolMapperArgs{
	ClaimName:        pulumi.String("string"),
	RealmId:          pulumi.String("string"),
	UserProperty:     pulumi.String("string"),
	AddToAccessToken: pulumi.Bool(false),
	AddToIdToken:     pulumi.Bool(false),
	AddToUserinfo:    pulumi.Bool(false),
	ClaimValueType:   pulumi.String("string"),
	ClientId:         pulumi.String("string"),
	ClientScopeId:    pulumi.String("string"),
	Name:             pulumi.String("string"),
})

    var userPropertyProtocolMapperResource = new UserPropertyProtocolMapper("userPropertyProtocolMapperResource", UserPropertyProtocolMapperArgs.builder()
    .claimName("string")
    .realmId("string")
    .userProperty("string")
    .addToAccessToken(false)
    .addToIdToken(false)
    .addToUserinfo(false)
    .claimValueType("string")
    .clientId("string")
    .clientScopeId("string")
    .name("string")
    .build());

    user_property_protocol_mapper_resource = keycloak.openid.UserPropertyProtocolMapper("userPropertyProtocolMapperResource",
    claim_name="string",
    realm_id="string",
    user_property="string",
    add_to_access_token=False,
    add_to_id_token=False,
    add_to_userinfo=False,
    claim_value_type="string",
    client_id="string",
    client_scope_id="string",
    name="string")

    const userPropertyProtocolMapperResource = new keycloak.openid.UserPropertyProtocolMapper("userPropertyProtocolMapperResource", {
    claimName: "string",
    realmId: "string",
    userProperty: "string",
    addToAccessToken: false,
    addToIdToken: false,
    addToUserinfo: false,
    claimValueType: "string",
    clientId: "string",
    clientScopeId: "string",
    name: "string",
});

    type: keycloak:openid:UserPropertyProtocolMapper
properties:
    addToAccessToken: false
    addToIdToken: false
    addToUserinfo: false
    claimName: string
    claimValueType: string
    clientId: string
    clientScopeId: string
    name: string
    realmId: string
    userProperty: string

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

    ClaimName string
    The name of the claim to insert into a token.
    RealmId string
    The realm this protocol mapper exists within.
    UserProperty string
    The built-in user property (such as email) to map a claim for.
    AddToAccessToken bool
    Indicates if the property should be added as a claim to the access token. Defaults to true.
    AddToIdToken bool
    Indicates if the property should be added as a claim to the id token. Defaults to true.
    AddToUserinfo bool
    Indicates if the property should be added as a claim to the UserInfo response body. Defaults to true.
    ClaimValueType string
    The claim type used when serializing JSON tokens. Can be one of String, JSON, long, int, or boolean. Defaults to String.
    ClientId string
    The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
    ClientScopeId string
    The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified. client_scope_id - (Required if client_id is not specified) The client scope this protocol mapper is attached to.
    Name string
    The display name of this protocol mapper in the GUI.
    ClaimName string
    The name of the claim to insert into a token.
    RealmId string
    The realm this protocol mapper exists within.
    UserProperty string
    The built-in user property (such as email) to map a claim for.
    AddToAccessToken bool
    Indicates if the property should be added as a claim to the access token. Defaults to true.
    AddToIdToken bool
    Indicates if the property should be added as a claim to the id token. Defaults to true.
    AddToUserinfo bool
    Indicates if the property should be added as a claim to the UserInfo response body. Defaults to true.
    ClaimValueType string
    The claim type used when serializing JSON tokens. Can be one of String, JSON, long, int, or boolean. Defaults to String.
    ClientId string
    The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
    ClientScopeId string
    The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified. client_scope_id - (Required if client_id is not specified) The client scope this protocol mapper is attached to.
    Name string
    The display name of this protocol mapper in the GUI.
    claimName String
    The name of the claim to insert into a token.
    realmId String
    The realm this protocol mapper exists within.
    userProperty String
    The built-in user property (such as email) to map a claim for.
    addToAccessToken Boolean
    Indicates if the property should be added as a claim to the access token. Defaults to true.
    addToIdToken Boolean
    Indicates if the property should be added as a claim to the id token. Defaults to true.
    addToUserinfo Boolean
    Indicates if the property should be added as a claim to the UserInfo response body. Defaults to true.
    claimValueType String
    The claim type used when serializing JSON tokens. Can be one of String, JSON, long, int, or boolean. Defaults to String.
    clientId String
    The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
    clientScopeId String
    The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified. client_scope_id - (Required if client_id is not specified) The client scope this protocol mapper is attached to.
    name String
    The display name of this protocol mapper in the GUI.
    claimName string
    The name of the claim to insert into a token.
    realmId string
    The realm this protocol mapper exists within.
    userProperty string
    The built-in user property (such as email) to map a claim for.
    addToAccessToken boolean
    Indicates if the property should be added as a claim to the access token. Defaults to true.
    addToIdToken boolean
    Indicates if the property should be added as a claim to the id token. Defaults to true.
    addToUserinfo boolean
    Indicates if the property should be added as a claim to the UserInfo response body. Defaults to true.
    claimValueType string
    The claim type used when serializing JSON tokens. Can be one of String, JSON, long, int, or boolean. Defaults to String.
    clientId string
    The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
    clientScopeId string
    The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified. client_scope_id - (Required if client_id is not specified) The client scope this protocol mapper is attached to.
    name string
    The display name of this protocol mapper in the GUI.
    claim_name str
    The name of the claim to insert into a token.
    realm_id str
    The realm this protocol mapper exists within.
    user_property str
    The built-in user property (such as email) to map a claim for.
    add_to_access_token bool
    Indicates if the property should be added as a claim to the access token. Defaults to true.
    add_to_id_token bool
    Indicates if the property should be added as a claim to the id token. Defaults to true.
    add_to_userinfo bool
    Indicates if the property should be added as a claim to the UserInfo response body. Defaults to true.
    claim_value_type str
    The claim type used when serializing JSON tokens. Can be one of String, JSON, long, int, or boolean. Defaults to String.
    client_id str
    The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
    client_scope_id str
    The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified. client_scope_id - (Required if client_id is not specified) The client scope this protocol mapper is attached to.
    name str
    The display name of this protocol mapper in the GUI.
    claimName String
    The name of the claim to insert into a token.
    realmId String
    The realm this protocol mapper exists within.
    userProperty String
    The built-in user property (such as email) to map a claim for.
    addToAccessToken Boolean
    Indicates if the property should be added as a claim to the access token. Defaults to true.
    addToIdToken Boolean
    Indicates if the property should be added as a claim to the id token. Defaults to true.
    addToUserinfo Boolean
    Indicates if the property should be added as a claim to the UserInfo response body. Defaults to true.
    claimValueType String
    The claim type used when serializing JSON tokens. Can be one of String, JSON, long, int, or boolean. Defaults to String.
    clientId String
    The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
    clientScopeId String
    The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified. client_scope_id - (Required if client_id is not specified) The client scope this protocol mapper is attached to.
    name String
    The display name of this protocol mapper in the GUI.

    Outputs

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

    Get an existing UserPropertyProtocolMapper 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?: UserPropertyProtocolMapperState, opts?: CustomResourceOptions): UserPropertyProtocolMapper
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        add_to_access_token: Optional[bool] = None,
        add_to_id_token: Optional[bool] = None,
        add_to_userinfo: Optional[bool] = None,
        claim_name: Optional[str] = None,
        claim_value_type: Optional[str] = None,
        client_id: Optional[str] = None,
        client_scope_id: Optional[str] = None,
        name: Optional[str] = None,
        realm_id: Optional[str] = None,
        user_property: Optional[str] = None) -> UserPropertyProtocolMapper
    func GetUserPropertyProtocolMapper(ctx *Context, name string, id IDInput, state *UserPropertyProtocolMapperState, opts ...ResourceOption) (*UserPropertyProtocolMapper, error)
    public static UserPropertyProtocolMapper Get(string name, Input<string> id, UserPropertyProtocolMapperState? state, CustomResourceOptions? opts = null)
    public static UserPropertyProtocolMapper get(String name, Output<String> id, UserPropertyProtocolMapperState state, CustomResourceOptions options)
    resources:  _:    type: keycloak:openid:UserPropertyProtocolMapper    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:
    AddToAccessToken bool
    Indicates if the property should be added as a claim to the access token. Defaults to true.
    AddToIdToken bool
    Indicates if the property should be added as a claim to the id token. Defaults to true.
    AddToUserinfo bool
    Indicates if the property should be added as a claim to the UserInfo response body. Defaults to true.
    ClaimName string
    The name of the claim to insert into a token.
    ClaimValueType string
    The claim type used when serializing JSON tokens. Can be one of String, JSON, long, int, or boolean. Defaults to String.
    ClientId string
    The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
    ClientScopeId string
    The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified. client_scope_id - (Required if client_id is not specified) The client scope this protocol mapper is attached to.
    Name string
    The display name of this protocol mapper in the GUI.
    RealmId string
    The realm this protocol mapper exists within.
    UserProperty string
    The built-in user property (such as email) to map a claim for.
    AddToAccessToken bool
    Indicates if the property should be added as a claim to the access token. Defaults to true.
    AddToIdToken bool
    Indicates if the property should be added as a claim to the id token. Defaults to true.
    AddToUserinfo bool
    Indicates if the property should be added as a claim to the UserInfo response body. Defaults to true.
    ClaimName string
    The name of the claim to insert into a token.
    ClaimValueType string
    The claim type used when serializing JSON tokens. Can be one of String, JSON, long, int, or boolean. Defaults to String.
    ClientId string
    The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
    ClientScopeId string
    The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified. client_scope_id - (Required if client_id is not specified) The client scope this protocol mapper is attached to.
    Name string
    The display name of this protocol mapper in the GUI.
    RealmId string
    The realm this protocol mapper exists within.
    UserProperty string
    The built-in user property (such as email) to map a claim for.
    addToAccessToken Boolean
    Indicates if the property should be added as a claim to the access token. Defaults to true.
    addToIdToken Boolean
    Indicates if the property should be added as a claim to the id token. Defaults to true.
    addToUserinfo Boolean
    Indicates if the property should be added as a claim to the UserInfo response body. Defaults to true.
    claimName String
    The name of the claim to insert into a token.
    claimValueType String
    The claim type used when serializing JSON tokens. Can be one of String, JSON, long, int, or boolean. Defaults to String.
    clientId String
    The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
    clientScopeId String
    The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified. client_scope_id - (Required if client_id is not specified) The client scope this protocol mapper is attached to.
    name String
    The display name of this protocol mapper in the GUI.
    realmId String
    The realm this protocol mapper exists within.
    userProperty String
    The built-in user property (such as email) to map a claim for.
    addToAccessToken boolean
    Indicates if the property should be added as a claim to the access token. Defaults to true.
    addToIdToken boolean
    Indicates if the property should be added as a claim to the id token. Defaults to true.
    addToUserinfo boolean
    Indicates if the property should be added as a claim to the UserInfo response body. Defaults to true.
    claimName string
    The name of the claim to insert into a token.
    claimValueType string
    The claim type used when serializing JSON tokens. Can be one of String, JSON, long, int, or boolean. Defaults to String.
    clientId string
    The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
    clientScopeId string
    The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified. client_scope_id - (Required if client_id is not specified) The client scope this protocol mapper is attached to.
    name string
    The display name of this protocol mapper in the GUI.
    realmId string
    The realm this protocol mapper exists within.
    userProperty string
    The built-in user property (such as email) to map a claim for.
    add_to_access_token bool
    Indicates if the property should be added as a claim to the access token. Defaults to true.
    add_to_id_token bool
    Indicates if the property should be added as a claim to the id token. Defaults to true.
    add_to_userinfo bool
    Indicates if the property should be added as a claim to the UserInfo response body. Defaults to true.
    claim_name str
    The name of the claim to insert into a token.
    claim_value_type str
    The claim type used when serializing JSON tokens. Can be one of String, JSON, long, int, or boolean. Defaults to String.
    client_id str
    The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
    client_scope_id str
    The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified. client_scope_id - (Required if client_id is not specified) The client scope this protocol mapper is attached to.
    name str
    The display name of this protocol mapper in the GUI.
    realm_id str
    The realm this protocol mapper exists within.
    user_property str
    The built-in user property (such as email) to map a claim for.
    addToAccessToken Boolean
    Indicates if the property should be added as a claim to the access token. Defaults to true.
    addToIdToken Boolean
    Indicates if the property should be added as a claim to the id token. Defaults to true.
    addToUserinfo Boolean
    Indicates if the property should be added as a claim to the UserInfo response body. Defaults to true.
    claimName String
    The name of the claim to insert into a token.
    claimValueType String
    The claim type used when serializing JSON tokens. Can be one of String, JSON, long, int, or boolean. Defaults to String.
    clientId String
    The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified.
    clientScopeId String
    The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified. client_scope_id - (Required if client_id is not specified) The client scope this protocol mapper is attached to.
    name String
    The display name of this protocol mapper in the GUI.
    realmId String
    The realm this protocol mapper exists within.
    userProperty String
    The built-in user property (such as email) to map a claim for.

    Import

    Protocol mappers can be imported using one of the following formats:

    • Client: {{realm_id}}/client/{{client_keycloak_id}}/{{protocol_mapper_id}}

    • Client Scope: {{realm_id}}/client-scope/{{client_scope_keycloak_id}}/{{protocol_mapper_id}}

    Example:

    bash

    $ pulumi import keycloak:openid/userPropertyProtocolMapper:UserPropertyProtocolMapper user_property_mapper my-realm/client/a7202154-8793-4656-b655-1dd18c181e14/71602afa-f7d1-4788-8c49-ef8fd00af0f4

    $ pulumi import keycloak:openid/userPropertyProtocolMapper:UserPropertyProtocolMapper user_property_mapper my-realm/client-scope/b799ea7e-73ee-4a73-990a-1eafebe8e20a/71602afa-f7d1-4788-8c49-ef8fd00af0f4

    To learn more about importing existing cloud resources, see Importing resources.

    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.1.0 published on Friday, Jan 17, 2025 by Pulumi
    pulumi/pulumi-keycloak