1. Pulumi Registry
  2. Keycloak
  3. API Docs
  4. openid
  5. FullNameProtocolMapper
keycloak logo
Keycloak v5.1.0, Mar 14 23

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)

using System.Collections.Generic;
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("openidClient", new()
    {
        RealmId = realm.Id,
        ClientId = "client",
        Enabled = true,
        AccessType = "CONFIDENTIAL",
        ValidRedirectUris = new[]
        {
            "http://localhost:8080/openid-callback",
        },
    });

    var fullNameMapper = new Keycloak.OpenId.FullNameProtocolMapper("fullNameMapper", new()
    {
        RealmId = realm.Id,
        ClientId = openidClient.Id,
    });

});

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, "openidClient", &openid.ClientArgs{
			RealmId:    realm.ID(),
			ClientId:   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.NewFullNameProtocolMapper(ctx, "fullNameMapper", &openid.FullNameProtocolMapperArgs{
			RealmId:  realm.ID(),
			ClientId: openidClient.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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("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())
            .build());

    }
}

import pulumi
import pulumi_keycloak as keycloak

realm = keycloak.Realm("realm",
    realm="my-realm",
    enabled=True)
openid_client = keycloak.openid.Client("openidClient",
    realm_id=realm.id,
    client_id="client",
    enabled=True,
    access_type="CONFIDENTIAL",
    valid_redirect_uris=["http://localhost:8080/openid-callback"])
full_name_mapper = keycloak.openid.FullNameProtocolMapper("fullNameMapper",
    realm_id=realm.id,
    client_id=openid_client.id)

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("openidClient", {
    realmId: realm.id,
    clientId: "client",
    enabled: true,
    accessType: "CONFIDENTIAL",
    validRedirectUris: ["http://localhost:8080/openid-callback"],
});
const fullNameMapper = new keycloak.openid.FullNameProtocolMapper("fullNameMapper", {
    realmId: realm.id,
    clientId: openidClient.id,
});

resources:
  realm:
    type: keycloak:Realm
    properties:
      realm: my-realm
      enabled: true
  openidClient:
    type: keycloak:openid:Client
    properties:
      realmId: ${realm.id}
      clientId: client
      enabled: true
      accessType: CONFIDENTIAL
      validRedirectUris:
        - http://localhost:8080/openid-callback
  fullNameMapper:
    type: keycloak:openid:FullNameProtocolMapper
    properties:
      realmId: ${realm.id}
      clientId: ${openidClient.id}

Client Scope)

using System.Collections.Generic;
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("clientScope", new()
    {
        RealmId = realm.Id,
    });

    var fullNameMapper = new Keycloak.OpenId.FullNameProtocolMapper("fullNameMapper", new()
    {
        RealmId = realm.Id,
        ClientScopeId = clientScope.Id,
    });

});

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, "clientScope", &openid.ClientScopeArgs{
			RealmId: realm.ID(),
		})
		if err != nil {
			return err
		}
		_, err = openid.NewFullNameProtocolMapper(ctx, "fullNameMapper", &openid.FullNameProtocolMapperArgs{
			RealmId:       realm.ID(),
			ClientScopeId: clientScope.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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())
            .build());

        var fullNameMapper = new FullNameProtocolMapper("fullNameMapper", FullNameProtocolMapperArgs.builder()        
            .realmId(realm.id())
            .clientScopeId(clientScope.id())
            .build());

    }
}

import pulumi
import pulumi_keycloak as keycloak

realm = keycloak.Realm("realm",
    realm="my-realm",
    enabled=True)
client_scope = keycloak.openid.ClientScope("clientScope", realm_id=realm.id)
full_name_mapper = keycloak.openid.FullNameProtocolMapper("fullNameMapper",
    realm_id=realm.id,
    client_scope_id=client_scope.id)

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("clientScope", {realmId: realm.id});
const fullNameMapper = new keycloak.openid.FullNameProtocolMapper("fullNameMapper", {
    realmId: realm.id,
    clientScopeId: clientScope.id,
});

resources:
  realm:
    type: keycloak:Realm
    properties:
      realm: my-realm
      enabled: true
  clientScope:
    type: keycloak:openid:ClientScope
    properties:
      realmId: ${realm.id}
  fullNameMapper:
    type: keycloak:openid:FullNameProtocolMapper
    properties:
      realmId: ${realm.id}
      clientScopeId: ${clientScope.id}

Create FullNameProtocolMapper Resource

new FullNameProtocolMapper(name: string, args: FullNameProtocolMapperArgs, opts?: CustomResourceOptions);
@overload
def FullNameProtocolMapper(resource_name: 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)
@overload
def FullNameProtocolMapper(resource_name: str,
                           args: FullNameProtocolMapperArgs,
                           opts: Optional[ResourceOptions] = 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.
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.

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 this protocol mapper exists within.

AddToAccessToken bool

Indicates if the user's full name should be added as a claim to the access token. Defaults to true.

AddToIdToken bool

Indicates if the user's full name should be added as a claim to the id token. Defaults to true.

AddToUserinfo bool

Indicates if the user's full name should be added as a claim to the UserInfo response body. Defaults to true.

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.

Name string

The display name of this protocol mapper in the GUI.

RealmId string

The realm this protocol mapper exists within.

AddToAccessToken bool

Indicates if the user's full name should be added as a claim to the access token. Defaults to true.

AddToIdToken bool

Indicates if the user's full name should be added as a claim to the id token. Defaults to true.

AddToUserinfo bool

Indicates if the user's full name should be added as a claim to the UserInfo response body. Defaults to true.

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.

Name string

The display name of this protocol mapper in the GUI.

realmId String

The realm this protocol mapper exists within.

addToAccessToken Boolean

Indicates if the user's full name should be added as a claim to the access token. Defaults to true.

addToIdToken Boolean

Indicates if the user's full name should be added as a claim to the id token. Defaults to true.

addToUserinfo Boolean

Indicates if the user's full name should be added as a claim to the UserInfo response body. Defaults to true.

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.

name String

The display name of this protocol mapper in the GUI.

realmId string

The realm this protocol mapper exists within.

addToAccessToken boolean

Indicates if the user's full name should be added as a claim to the access token. Defaults to true.

addToIdToken boolean

Indicates if the user's full name should be added as a claim to the id token. Defaults to true.

addToUserinfo boolean

Indicates if the user's full name should be added as a claim to the UserInfo response body. Defaults to true.

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.

name string

The display name of this protocol mapper in the GUI.

realm_id str

The realm this protocol mapper exists within.

add_to_access_token bool

Indicates if the user's full name should be added as a claim to the access token. Defaults to true.

add_to_id_token bool

Indicates if the user's full name should be added as a claim to the id token. Defaults to true.

add_to_userinfo bool

Indicates if the user's full name should be added as a claim to the UserInfo response body. Defaults to true.

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.

name str

The display name of this protocol mapper in the GUI.

realmId String

The realm this protocol mapper exists within.

addToAccessToken Boolean

Indicates if the user's full name should be added as a claim to the access token. Defaults to true.

addToIdToken Boolean

Indicates if the user's full name should be added as a claim to the id token. Defaults to true.

addToUserinfo Boolean

Indicates if the user's full name should be added as a claim to the UserInfo response body. Defaults to true.

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.

name String

The display name of this protocol mapper in the GUI.

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

Indicates if the user's full name should be added as a claim to the access token. Defaults to true.

AddToIdToken bool

Indicates if the user's full name should be added as a claim to the id token. Defaults to true.

AddToUserinfo bool

Indicates if the user's full name should be added as a claim to the UserInfo response body. Defaults to true.

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.

Name string

The display name of this protocol mapper in the GUI.

RealmId string

The realm this protocol mapper exists within.

AddToAccessToken bool

Indicates if the user's full name should be added as a claim to the access token. Defaults to true.

AddToIdToken bool

Indicates if the user's full name should be added as a claim to the id token. Defaults to true.

AddToUserinfo bool

Indicates if the user's full name should be added as a claim to the UserInfo response body. Defaults to true.

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.

Name string

The display name of this protocol mapper in the GUI.

RealmId string

The realm this protocol mapper exists within.

addToAccessToken Boolean

Indicates if the user's full name should be added as a claim to the access token. Defaults to true.

addToIdToken Boolean

Indicates if the user's full name should be added as a claim to the id token. Defaults to true.

addToUserinfo Boolean

Indicates if the user's full name should be added as a claim to the UserInfo response body. Defaults to true.

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.

name String

The display name of this protocol mapper in the GUI.

realmId String

The realm this protocol mapper exists within.

addToAccessToken boolean

Indicates if the user's full name should be added as a claim to the access token. Defaults to true.

addToIdToken boolean

Indicates if the user's full name should be added as a claim to the id token. Defaults to true.

addToUserinfo boolean

Indicates if the user's full name should be added as a claim to the UserInfo response body. Defaults to true.

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.

name string

The display name of this protocol mapper in the GUI.

realmId string

The realm this protocol mapper exists within.

add_to_access_token bool

Indicates if the user's full name should be added as a claim to the access token. Defaults to true.

add_to_id_token bool

Indicates if the user's full name should be added as a claim to the id token. Defaults to true.

add_to_userinfo bool

Indicates if the user's full name should be added as a claim to the UserInfo response body. Defaults to true.

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.

name str

The display name of this protocol mapper in the GUI.

realm_id str

The realm this protocol mapper exists within.

addToAccessToken Boolean

Indicates if the user's full name should be added as a claim to the access token. Defaults to true.

addToIdToken Boolean

Indicates if the user's full name should be added as a claim to the id token. Defaults to true.

addToUserinfo Boolean

Indicates if the user's full name should be added as a claim to the UserInfo response body. Defaults to true.

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.

name String

The display name of this protocol mapper in the GUI.

realmId String

The realm this protocol mapper exists within.

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}} Examplebash

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

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

Package Details

Repository
Keycloak pulumi/pulumi-keycloak
License
Apache-2.0
Notes

This Pulumi package is based on the keycloak Terraform Provider.