Docs Packages
  1. Packages
  2. Keycloak
  3. API Docs
  4. openid
  5. FullNameProtocolMapper
Keycloak v5.3.2 published on Friday, May 10, 2024 by Pulumi
pulumi/pulumi-keycloak

keycloak.openid.FullNameProtocolMapper

Explore with Pulumi AI

keycloak logo
Keycloak v5.3.2 published on Friday, May 10, 2024 by Pulumi
pulumi/pulumi-keycloak

    # keycloak.openid.FullNameProtocolMapper

    Allows for creating and managing full name protocol mappers within Keycloak.

    Full name protocol mappers allow you to map a user’s first and last name to the OpenID Connect name 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: "test-client",
    name: "test client",
    enabled: true,
    accessType: "CONFIDENTIAL",
    validRedirectUris: ["http://localhost:8080/openid-callback"],
});
const fullNameMapper = new keycloak.openid.FullNameProtocolMapper("full_name_mapper", {
    realmId: realm.id,
    clientId: openidClient.id,
    name: "full-name-mapper",
});

    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="test-client",
    name="test client",
    enabled=True,
    access_type="CONFIDENTIAL",
    valid_redirect_uris=["http://localhost:8080/openid-callback"])
full_name_mapper = keycloak.openid.FullNameProtocolMapper("full_name_mapper",
    realm_id=realm.id,
    client_id=openid_client.id,
    name="full-name-mapper")

    package main

import (
	"github.com/pulumi/pulumi-keycloak/sdk/v5/go/keycloak"
	"github.com/pulumi/pulumi-keycloak/sdk/v5/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("test-client"),
			Name:       pulumi.String("test 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.NewFullNameProtocolMapper(ctx, "full_name_mapper", &openid.FullNameProtocolMapperArgs{
			RealmId:  realm.ID(),
			ClientId: openidClient.ID(),
			Name:     pulumi.String("full-name-mapper"),
		})
		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 = "test-client",
        Name = "test client",
        Enabled = true,
        AccessType = "CONFIDENTIAL",
        ValidRedirectUris = new[]
        {
            "http://localhost:8080/openid-callback",
        },
    });

    var fullNameMapper = new Keycloak.OpenId.FullNameProtocolMapper("full_name_mapper", new()
    {
        RealmId = realm.Id,
        ClientId = openidClient.Id,
        Name = "full-name-mapper",
    });

});

    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.FullNameProtocolMapper;
import com.pulumi.keycloak.openid.FullNameProtocolMapperArgs;
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("test-client")
            .name("test client")
            .enabled(true)
            .accessType("CONFIDENTIAL")
            .validRedirectUris("http://localhost:8080/openid-callback")
            .build());

        var fullNameMapper = new FullNameProtocolMapper("fullNameMapper", FullNameProtocolMapperArgs.builder()        
            .realmId(realm.id())
            .clientId(openidClient.id())
            .name("full-name-mapper")
            .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: test-client
      name: test client
      enabled: true
      accessType: CONFIDENTIAL
      validRedirectUris:
        - http://localhost:8080/openid-callback
  fullNameMapper:
    type: keycloak:openid:FullNameProtocolMapper
    name: full_name_mapper
    properties:
      realmId: ${realm.id}
      clientId: ${openidClient.id}
      name: full-name-mapper

    Example Usage (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: "test-client-scope",
});
const fullNameMapper = new keycloak.openid.FullNameProtocolMapper("full_name_mapper", {
    realmId: realm.id,
    clientScopeId: clientScope.id,
    name: "full-name-mapper",
});

    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="test-client-scope")
full_name_mapper = keycloak.openid.FullNameProtocolMapper("full_name_mapper",
    realm_id=realm.id,
    client_scope_id=client_scope.id,
    name="full-name-mapper")

    package main

import (
	"github.com/pulumi/pulumi-keycloak/sdk/v5/go/keycloak"
	"github.com/pulumi/pulumi-keycloak/sdk/v5/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("test-client-scope"),
		})
		if err != nil {
			return err
		}
		_, err = openid.NewFullNameProtocolMapper(ctx, "full_name_mapper", &openid.FullNameProtocolMapperArgs{
			RealmId:       realm.ID(),
			ClientScopeId: clientScope.ID(),
			Name:          pulumi.String("full-name-mapper"),
		})
		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 = "test-client-scope",
    });

    var fullNameMapper = new Keycloak.OpenId.FullNameProtocolMapper("full_name_mapper", new()
    {
        RealmId = realm.Id,
        ClientScopeId = clientScope.Id,
        Name = "full-name-mapper",
    });

});

    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.FullNameProtocolMapper;
import com.pulumi.keycloak.openid.FullNameProtocolMapperArgs;
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("test-client-scope")
            .build());

        var fullNameMapper = new FullNameProtocolMapper("fullNameMapper", FullNameProtocolMapperArgs.builder()        
            .realmId(realm.id())
            .clientScopeId(clientScope.id())
            .name("full-name-mapper")
            .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: test-client-scope
  fullNameMapper:
    type: keycloak:openid:FullNameProtocolMapper
    name: full_name_mapper
    properties:
      realmId: ${realm.id}
      clientScopeId: ${clientScope.id}
      name: full-name-mapper

    Argument Reference

    The following arguments are supported:

    • realm_id - (Required) The realm this protocol mapper exists within.
    • client_id - (Required if client_scope_id is not specified) The client this protocol mapper is attached to.
    • client_scope_id - (Required if client_id is not specified) The client scope this protocol mapper is attached to.
    • name - (Required) The display name of this protocol mapper in the GUI.
    • add_to_id_token - (Optional) Indicates if the user’s full name should be added as a claim to the id token. Defaults to true.
    • add_to_access_token - (Optional) Indicates if the user’s full name should be added as a claim to the access token. Defaults to true.
    • add_to_userinfo - (Optional) Indicates if the user’s full name should be added as a claim to the UserInfo response body. Defaults to true.

    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:

    $ terraform import keycloak_openid_full_name_protocol_mapper.full_name_mapper my-realm/client/a7202154-8793-4656-b655-1dd18c181e14/71602afa-f7d1-4788-8c49-ef8fd00af0f4
$ terraform import keycloak_openid_full_name_protocol_mapper.full_name_mapper my-realm/client-scope/b799ea7e-73ee-4a73-990a-1eafebe8e20a/71602afa-f7d1-4788-8c49-ef8fd00af0f4

    Create FullNameProtocolMapper Resource

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

    Constructor syntax

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

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

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

    example, err := openid.NewFullNameProtocolMapper(ctx, "fullNameProtocolMapperResource", &openid.FullNameProtocolMapperArgs{
	RealmId:          pulumi.String("string"),
	AddToAccessToken: pulumi.Bool(false),
	AddToIdToken:     pulumi.Bool(false),
	AddToUserinfo:    pulumi.Bool(false),
	ClientId:         pulumi.String("string"),
	ClientScopeId:    pulumi.String("string"),
	Name:             pulumi.String("string"),
})

    var fullNameProtocolMapperResource = new FullNameProtocolMapper("fullNameProtocolMapperResource", FullNameProtocolMapperArgs.builder()
    .realmId("string")
    .addToAccessToken(false)
    .addToIdToken(false)
    .addToUserinfo(false)
    .clientId("string")
    .clientScopeId("string")
    .name("string")
    .build());

    full_name_protocol_mapper_resource = keycloak.openid.FullNameProtocolMapper("fullNameProtocolMapperResource",
    realm_id="string",
    add_to_access_token=False,
    add_to_id_token=False,
    add_to_userinfo=False,
    client_id="string",
    client_scope_id="string",
    name="string")

    const fullNameProtocolMapperResource = new keycloak.openid.FullNameProtocolMapper("fullNameProtocolMapperResource", {
    realmId: "string",
    addToAccessToken: false,
    addToIdToken: false,
    addToUserinfo: false,
    clientId: "string",
    clientScopeId: "string",
    name: "string",
});

    type: keycloak:openid:FullNameProtocolMapper
properties:
    addToAccessToken: false
    addToIdToken: false
    addToUserinfo: false
    clientId: string
    clientScopeId: string
    name: string
    realmId: string

    FullNameProtocolMapper Resource Properties

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

    Inputs

    The FullNameProtocolMapper resource accepts the following input properties:

    RealmId string
    The realm id where the associated client or client scope exists.
    AddToAccessToken bool
    AddToIdToken bool
    AddToUserinfo bool
    ClientId string
    The mapper's associated client. Cannot be used at the same time as client_scope_id.
    ClientScopeId string
    The mapper's associated client scope. Cannot be used at the same time as client_id.
    Name string
    A human-friendly name that will appear in the Keycloak console.
    RealmId string
    The realm id where the associated client or client scope exists.
    AddToAccessToken bool
    AddToIdToken bool
    AddToUserinfo bool
    ClientId string
    The mapper's associated client. Cannot be used at the same time as client_scope_id.
    ClientScopeId string
    The mapper's associated client scope. Cannot be used at the same time as client_id.
    Name string
    A human-friendly name that will appear in the Keycloak console.
    realmId String
    The realm id where the associated client or client scope exists.
    addToAccessToken Boolean
    addToIdToken Boolean
    addToUserinfo Boolean
    clientId String
    The mapper's associated client. Cannot be used at the same time as client_scope_id.
    clientScopeId String
    The mapper's associated client scope. Cannot be used at the same time as client_id.
    name String
    A human-friendly name that will appear in the Keycloak console.
    realmId string
    The realm id where the associated client or client scope exists.
    addToAccessToken boolean
    addToIdToken boolean
    addToUserinfo boolean
    clientId string
    The mapper's associated client. Cannot be used at the same time as client_scope_id.
    clientScopeId string
    The mapper's associated client scope. Cannot be used at the same time as client_id.
    name string
    A human-friendly name that will appear in the Keycloak console.
    realm_id str
    The realm id where the associated client or client scope exists.
    add_to_access_token bool
    add_to_id_token bool
    add_to_userinfo bool
    client_id str
    The mapper's associated client. Cannot be used at the same time as client_scope_id.
    client_scope_id str
    The mapper's associated client scope. Cannot be used at the same time as client_id.
    name str
    A human-friendly name that will appear in the Keycloak console.
    realmId String
    The realm id where the associated client or client scope exists.
    addToAccessToken Boolean
    addToIdToken Boolean
    addToUserinfo Boolean
    clientId String
    The mapper's associated client. Cannot be used at the same time as client_scope_id.
    clientScopeId String
    The mapper's associated client scope. Cannot be used at the same time as client_id.
    name String
    A human-friendly name that will appear in the Keycloak console.

    Outputs

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

    Get an existing FullNameProtocolMapper 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?: FullNameProtocolMapperState, opts?: CustomResourceOptions): FullNameProtocolMapper
    @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,
        client_id: Optional[str] = None,
        client_scope_id: Optional[str] = None,
        name: Optional[str] = None,
        realm_id: Optional[str] = None) -> FullNameProtocolMapper
    func GetFullNameProtocolMapper(ctx *Context, name string, id IDInput, state *FullNameProtocolMapperState, opts ...ResourceOption) (*FullNameProtocolMapper, error)
    public static FullNameProtocolMapper Get(string name, Input<string> id, FullNameProtocolMapperState? state, CustomResourceOptions? opts = null)
    public static FullNameProtocolMapper get(String name, Output<String> id, FullNameProtocolMapperState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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
    AddToIdToken bool
    AddToUserinfo bool
    ClientId string
    The mapper's associated client. Cannot be used at the same time as client_scope_id.
    ClientScopeId string
    The mapper's associated client scope. Cannot be used at the same time as client_id.
    Name string
    A human-friendly name that will appear in the Keycloak console.
    RealmId string
    The realm id where the associated client or client scope exists.
    AddToAccessToken bool
    AddToIdToken bool
    AddToUserinfo bool
    ClientId string
    The mapper's associated client. Cannot be used at the same time as client_scope_id.
    ClientScopeId string
    The mapper's associated client scope. Cannot be used at the same time as client_id.
    Name string
    A human-friendly name that will appear in the Keycloak console.
    RealmId string
    The realm id where the associated client or client scope exists.
    addToAccessToken Boolean
    addToIdToken Boolean
    addToUserinfo Boolean
    clientId String
    The mapper's associated client. Cannot be used at the same time as client_scope_id.
    clientScopeId String
    The mapper's associated client scope. Cannot be used at the same time as client_id.
    name String
    A human-friendly name that will appear in the Keycloak console.
    realmId String
    The realm id where the associated client or client scope exists.
    addToAccessToken boolean
    addToIdToken boolean
    addToUserinfo boolean
    clientId string
    The mapper's associated client. Cannot be used at the same time as client_scope_id.
    clientScopeId string
    The mapper's associated client scope. Cannot be used at the same time as client_id.
    name string
    A human-friendly name that will appear in the Keycloak console.
    realmId string
    The realm id where the associated client or client scope exists.
    add_to_access_token bool
    add_to_id_token bool
    add_to_userinfo bool
    client_id str
    The mapper's associated client. Cannot be used at the same time as client_scope_id.
    client_scope_id str
    The mapper's associated client scope. Cannot be used at the same time as client_id.
    name str
    A human-friendly name that will appear in the Keycloak console.
    realm_id str
    The realm id where the associated client or client scope exists.
    addToAccessToken Boolean
    addToIdToken Boolean
    addToUserinfo Boolean
    clientId String
    The mapper's associated client. Cannot be used at the same time as client_scope_id.
    clientScopeId String
    The mapper's associated client scope. Cannot be used at the same time as client_id.
    name String
    A human-friendly name that will appear in the Keycloak console.
    realmId String
    The realm id where the associated client or client scope exists.

    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 v5.3.2 published on Friday, May 10, 2024 by Pulumi
    pulumi/pulumi-keycloak