Class FullNameProtocolMapper

# 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 Pulumi;
using Keycloak = Pulumi.Keycloak;

class MyStack : Stack
{
public MyStack()
{
    var realm = new Keycloak.Realm("realm", new Keycloak.RealmArgs
    {
        Enabled = true,
        Realm = "my-realm",
    });
    var openidClient = new Keycloak.OpenId.Client("openidClient", new Keycloak.OpenId.ClientArgs
    {
        AccessType = "CONFIDENTIAL",
        ClientId = "test-client",
        Enabled = true,
        RealmId = realm.Id,
        ValidRedirectUris = 
        {
            "http://localhost:8080/openid-callback",
        },
    });
    var fullNameMapper = new Keycloak.OpenId.FullNameProtocolMapper("fullNameMapper", new Keycloak.OpenId.FullNameProtocolMapperArgs
    {
        ClientId = openidClient.Id,
        RealmId = realm.Id,
    });
}

}

Example Usage (Client Scope)

using Pulumi;
using Keycloak = Pulumi.Keycloak;

class MyStack : Stack
{
public MyStack()
{
    var realm = new Keycloak.Realm("realm", new Keycloak.RealmArgs
    {
        Enabled = true,
        Realm = "my-realm",
    });
    var clientScope = new Keycloak.OpenId.ClientScope("clientScope", new Keycloak.OpenId.ClientScopeArgs
    {
        RealmId = realm.Id,
    });
    var fullNameMapper = new Keycloak.OpenId.FullNameProtocolMapper("fullNameMapper", new Keycloak.OpenId.FullNameProtocolMapperArgs
    {
        ClientScopeId = clientScope.Id,
        RealmId = realm.Id,
    });
}

}

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

Constructors

View Source

FullNameProtocolMapper(String, FullNameProtocolMapperArgs, CustomResourceOptions)

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

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

The unique name of the resource
FullNameProtocolMapperArgs args

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

A bag of options that control this resource's behavior

Properties

View Source

AddToAccessToken

Declaration
public Output<bool?> AddToAccessToken { get; }
Property Value
Type Description
Output<System.Nullable<System.Boolean>>
View Source

AddToIdToken

Declaration
public Output<bool?> AddToIdToken { get; }
Property Value
Type Description
Output<System.Nullable<System.Boolean>>
View Source

AddToUserinfo

Declaration
public Output<bool?> AddToUserinfo { get; }
Property Value
Type Description
Output<System.Nullable<System.Boolean>>
View Source

ClientId

The mapper's associated client. Cannot be used at the same time as client_scope_id.

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

ClientScopeId

The mapper's associated client scope. Cannot be used at the same time as client_id.

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

Name

A human-friendly name that will appear in the Keycloak console.

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

RealmId

The realm id where the associated client or client scope exists.

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

Methods

View Source

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

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

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

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

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

Any extra arguments used during the lookup.
CustomResourceOptions options

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