GroupMembershipProtocolMapper

# keycloak.openid.GroupMembershipProtocolMapper

Allows for creating and managing group membership protocol mappers within Keycloak.

Group membership protocol mappers allow you to map a user’s group memberships 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", {
    enabled: true,
    realm: "my-realm",
});
const openidClient = new keycloak.openid.Client("openid_client", {
    accessType: "CONFIDENTIAL",
    clientId: "test-client",
    enabled: true,
    realmId: realm.id,
    validRedirectUris: ["http://localhost:8080/openid-callback"],
});
const groupMembershipMapper = new keycloak.openid.GroupMembershipProtocolMapper("group_membership_mapper", {
    claimName: "groups",
    clientId: openidClient.id,
    realmId: realm.id,
});

import pulumi
import pulumi_keycloak as keycloak

realm = keycloak.Realm("realm",
    enabled=True,
    realm="my-realm")
openid_client = keycloak.openid.Client("openidClient",
    access_type="CONFIDENTIAL",
    client_id="test-client",
    enabled=True,
    realm_id=realm.id,
    valid_redirect_uris=["http://localhost:8080/openid-callback"])
group_membership_mapper = keycloak.openid.GroupMembershipProtocolMapper("groupMembershipMapper",
    claim_name="groups",
    client_id=openid_client.id,
    realm_id=realm.id)

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 groupMembershipMapper = new Keycloak.OpenId.GroupMembershipProtocolMapper("groupMembershipMapper", new Keycloak.OpenId.GroupMembershipProtocolMapperArgs
        {
            ClaimName = "groups",
            ClientId = openidClient.Id,
            RealmId = realm.Id,
        });
    }

}

Example Usage (Client Scope)

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

const realm = new keycloak.Realm("realm", {
    enabled: true,
    realm: "my-realm",
});
const clientScope = new keycloak.openid.ClientScope("client_scope", {
    realmId: realm.id,
});
const groupMembershipMapper = new keycloak.openid.GroupMembershipProtocolMapper("group_membership_mapper", {
    claimName: "groups",
    clientScopeId: clientScope.id,
    realmId: realm.id,
});

import pulumi
import pulumi_keycloak as keycloak

realm = keycloak.Realm("realm",
    enabled=True,
    realm="my-realm")
client_scope = keycloak.openid.ClientScope("clientScope", realm_id=realm.id)
group_membership_mapper = keycloak.openid.GroupMembershipProtocolMapper("groupMembershipMapper",
    claim_name="groups",
    client_scope_id=client_scope.id,
    realm_id=realm.id)

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 groupMembershipMapper = new Keycloak.OpenId.GroupMembershipProtocolMapper("groupMembershipMapper", new Keycloak.OpenId.GroupMembershipProtocolMapperArgs
        {
            ClaimName = "groups",
            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.
claim_name - (Required) The name of the claim to insert into a token.
full_path - (Optional) Indicates whether the full path of the group including its parents will be used. Defaults to true.
add_to_id_token - (Optional) Indicates if the property should be added as a claim to the id token. Defaults to true.
add_to_access_token - (Optional) Indicates if the property should be added as a claim to the access token. Defaults to true.
add_to_userinfo - (Optional) Indicates if the property should be added as a claim to the UserInfo response body. Defaults to true.

Create a GroupMembershipProtocolMapper Resource

new GroupMembershipProtocolMapper(name: string, args: GroupMembershipProtocolMapperArgs, opts?: CustomResourceOptions);

def GroupMembershipProtocolMapper(resource_name, opts=None, add_to_access_token=None, add_to_id_token=None, add_to_userinfo=None, claim_name=None, client_id=None, client_scope_id=None, full_path=None, name=None, realm_id=None, __props__=None);

func NewGroupMembershipProtocolMapper(ctx *Context, name string, args GroupMembershipProtocolMapperArgs, opts ...ResourceOption) (*GroupMembershipProtocolMapper, error)

public GroupMembershipProtocolMapper(string name, GroupMembershipProtocolMapperArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args GroupMembershipProtocolMapperArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args GroupMembershipProtocolMapperArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GroupMembershipProtocolMapperArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

GroupMembershipProtocolMapper Resource Properties

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

Inputs

The GroupMembershipProtocolMapper resource accepts the following input properties:

ClaimName string
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.
FullPath bool
Name string: A human-friendly name that will appear in the Keycloak console.

ClaimName string
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.
FullPath bool
Name string: A human-friendly name that will appear in the Keycloak console.

claimName string
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.
fullPath boolean
name string: A human-friendly name that will appear in the Keycloak console.

claim_name str
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.
full_path bool
name str: A human-friendly name that will appear in the Keycloak console.

Outputs

All input properties are implicitly available as output properties. Additionally, the GroupMembershipProtocolMapper 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 str: The provider-assigned unique ID for this managed resource.

Look up an Existing GroupMembershipProtocolMapper Resource

Get an existing GroupMembershipProtocolMapper 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?: GroupMembershipProtocolMapperState, opts?: CustomResourceOptions): GroupMembershipProtocolMapper

static get(resource_name, id, opts=None, add_to_access_token=None, add_to_id_token=None, add_to_userinfo=None, claim_name=None, client_id=None, client_scope_id=None, full_path=None, name=None, realm_id=None, __props__=None);

func GetGroupMembershipProtocolMapper(ctx *Context, name string, id IDInput, state *GroupMembershipProtocolMapperState, opts ...ResourceOption) (*GroupMembershipProtocolMapper, error)

public static GroupMembershipProtocolMapper Get(string name, Input<string> id, GroupMembershipProtocolMapperState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

AddToAccessToken bool
AddToIdToken bool
AddToUserinfo bool
ClaimName string
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.
FullPath bool
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
ClaimName string
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.
FullPath bool
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
claimName string
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.
fullPath boolean
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
claim_name str
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.
full_path bool
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.

Package Details

Repository: https://github.com/pulumi/pulumi-keycloak
License: Apache-2.0
Notes: This Pulumi package is based on the keycloak Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud