Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Keycloak Provider
  3. API Docs
  4. openid
  5. AudienceProtocolMapper
Keycloak v6.2.1 published on Monday, Feb 3, 2025 by Pulumi
pulumi/pulumi-keycloak

keycloak.openid.AudienceProtocolMapper

Explore with Pulumi AI

keycloak logo
Keycloak v6.2.1 published on Monday, Feb 3, 2025 by Pulumi
pulumi/pulumi-keycloak

    Allows for creating and managing audience protocol mappers within Keycloak.

    Audience protocol mappers allow you to add audiences to the aud claim within issued tokens. The audience can be a custom string, or it can be mapped to the ID of a pre-existing client.

    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 audienceMapper = new keycloak.openid.AudienceProtocolMapper("audience_mapper", {
    realmId: realm.id,
    clientId: openidClient.id,
    name: "audience-mapper",
    includedCustomAudience: "foo",
});

    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"])
audience_mapper = keycloak.openid.AudienceProtocolMapper("audience_mapper",
    realm_id=realm.id,
    client_id=openid_client.id,
    name="audience-mapper",
    included_custom_audience="foo")

    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.NewAudienceProtocolMapper(ctx, "audience_mapper", &openid.AudienceProtocolMapperArgs{
			RealmId:                realm.ID(),
			ClientId:               openidClient.ID(),
			Name:                   pulumi.String("audience-mapper"),
			IncludedCustomAudience: pulumi.String("foo"),
		})
		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 audienceMapper = new Keycloak.OpenId.AudienceProtocolMapper("audience_mapper", new()
    {
        RealmId = realm.Id,
        ClientId = openidClient.Id,
        Name = "audience-mapper",
        IncludedCustomAudience = "foo",
    });

});

    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.AudienceProtocolMapper;
import com.pulumi.keycloak.openid.AudienceProtocolMapperArgs;
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 audienceMapper = new AudienceProtocolMapper("audienceMapper", AudienceProtocolMapperArgs.builder()
            .realmId(realm.id())
            .clientId(openidClient.id())
            .name("audience-mapper")
            .includedCustomAudience("foo")
            .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
  audienceMapper:
    type: keycloak:openid:AudienceProtocolMapper
    name: audience_mapper
    properties:
      realmId: ${realm.id}
      clientId: ${openidClient.id}
      name: audience-mapper
      includedCustomAudience: foo

    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 audienceMapper = new keycloak.openid.AudienceProtocolMapper("audience_mapper", {
    realmId: realm.id,
    clientScopeId: clientScope.id,
    name: "audience-mapper",
    includedCustomAudience: "foo",
});

    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")
audience_mapper = keycloak.openid.AudienceProtocolMapper("audience_mapper",
    realm_id=realm.id,
    client_scope_id=client_scope.id,
    name="audience-mapper",
    included_custom_audience="foo")

    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("test-client-scope"),
		})
		if err != nil {
			return err
		}
		_, err = openid.NewAudienceProtocolMapper(ctx, "audience_mapper", &openid.AudienceProtocolMapperArgs{
			RealmId:                realm.ID(),
			ClientScopeId:          clientScope.ID(),
			Name:                   pulumi.String("audience-mapper"),
			IncludedCustomAudience: pulumi.String("foo"),
		})
		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 audienceMapper = new Keycloak.OpenId.AudienceProtocolMapper("audience_mapper", new()
    {
        RealmId = realm.Id,
        ClientScopeId = clientScope.Id,
        Name = "audience-mapper",
        IncludedCustomAudience = "foo",
    });

});

    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.AudienceProtocolMapper;
import com.pulumi.keycloak.openid.AudienceProtocolMapperArgs;
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 audienceMapper = new AudienceProtocolMapper("audienceMapper", AudienceProtocolMapperArgs.builder()
            .realmId(realm.id())
            .clientScopeId(clientScope.id())
            .name("audience-mapper")
            .includedCustomAudience("foo")
            .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
  audienceMapper:
    type: keycloak:openid:AudienceProtocolMapper
    name: audience_mapper
    properties:
      realmId: ${realm.id}
      clientScopeId: ${clientScope.id}
      name: audience-mapper
      includedCustomAudience: foo

    Create AudienceProtocolMapper Resource

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

    Constructor syntax

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

@overload
def AudienceProtocolMapper(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,
                           client_id: Optional[str] = None,
                           client_scope_id: Optional[str] = None,
                           included_client_audience: Optional[str] = None,
                           included_custom_audience: Optional[str] = None,
                           name: Optional[str] = None)
    func NewAudienceProtocolMapper(ctx *Context, name string, args AudienceProtocolMapperArgs, opts ...ResourceOption) (*AudienceProtocolMapper, error)
    public AudienceProtocolMapper(string name, AudienceProtocolMapperArgs args, CustomResourceOptions? opts = null)
    public AudienceProtocolMapper(String name, AudienceProtocolMapperArgs args)
public AudienceProtocolMapper(String name, AudienceProtocolMapperArgs args, CustomResourceOptions options)

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

    example, err := openid.NewAudienceProtocolMapper(ctx, "audienceProtocolMapperResource", &openid.AudienceProtocolMapperArgs{
	RealmId:                pulumi.String("string"),
	AddToAccessToken:       pulumi.Bool(false),
	AddToIdToken:           pulumi.Bool(false),
	ClientId:               pulumi.String("string"),
	ClientScopeId:          pulumi.String("string"),
	IncludedClientAudience: pulumi.String("string"),
	IncludedCustomAudience: pulumi.String("string"),
	Name:                   pulumi.String("string"),
})

    var audienceProtocolMapperResource = new AudienceProtocolMapper("audienceProtocolMapperResource", AudienceProtocolMapperArgs.builder()
    .realmId("string")
    .addToAccessToken(false)
    .addToIdToken(false)
    .clientId("string")
    .clientScopeId("string")
    .includedClientAudience("string")
    .includedCustomAudience("string")
    .name("string")
    .build());

    audience_protocol_mapper_resource = keycloak.openid.AudienceProtocolMapper("audienceProtocolMapperResource",
    realm_id="string",
    add_to_access_token=False,
    add_to_id_token=False,
    client_id="string",
    client_scope_id="string",
    included_client_audience="string",
    included_custom_audience="string",
    name="string")

    const audienceProtocolMapperResource = new keycloak.openid.AudienceProtocolMapper("audienceProtocolMapperResource", {
    realmId: "string",
    addToAccessToken: false,
    addToIdToken: false,
    clientId: "string",
    clientScopeId: "string",
    includedClientAudience: "string",
    includedCustomAudience: "string",
    name: "string",
});

    type: keycloak:openid:AudienceProtocolMapper
properties:
    addToAccessToken: false
    addToIdToken: false
    clientId: string
    clientScopeId: string
    includedClientAudience: string
    includedCustomAudience: string
    name: string
    realmId: string

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

    RealmId string
    The realm this protocol mapper exists within.
    AddToAccessToken bool
    Indicates if the audience should be included in the aud claim for the id token. Defaults to true.
    AddToIdToken bool
    Indicates if the audience should be included in the aud claim for the id token. 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.
    IncludedClientAudience string
    A client ID to include within the token's aud claim. Conflicts with included_custom_audience. One of included_client_audience or included_custom_audience must be specified.
    IncludedCustomAudience string
    A custom audience to include within the token's aud claim. Conflicts with included_client_audience. One of included_client_audience or included_custom_audience 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 audience should be included in the aud claim for the id token. Defaults to true.
    AddToIdToken bool
    Indicates if the audience should be included in the aud claim for the id token. 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.
    IncludedClientAudience string
    A client ID to include within the token's aud claim. Conflicts with included_custom_audience. One of included_client_audience or included_custom_audience must be specified.
    IncludedCustomAudience string
    A custom audience to include within the token's aud claim. Conflicts with included_client_audience. One of included_client_audience or included_custom_audience 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 audience should be included in the aud claim for the id token. Defaults to true.
    addToIdToken Boolean
    Indicates if the audience should be included in the aud claim for the id token. 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.
    includedClientAudience String
    A client ID to include within the token's aud claim. Conflicts with included_custom_audience. One of included_client_audience or included_custom_audience must be specified.
    includedCustomAudience String
    A custom audience to include within the token's aud claim. Conflicts with included_client_audience. One of included_client_audience or included_custom_audience 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 audience should be included in the aud claim for the id token. Defaults to true.
    addToIdToken boolean
    Indicates if the audience should be included in the aud claim for the id token. 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.
    includedClientAudience string
    A client ID to include within the token's aud claim. Conflicts with included_custom_audience. One of included_client_audience or included_custom_audience must be specified.
    includedCustomAudience string
    A custom audience to include within the token's aud claim. Conflicts with included_client_audience. One of included_client_audience or included_custom_audience 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 audience should be included in the aud claim for the id token. Defaults to true.
    add_to_id_token bool
    Indicates if the audience should be included in the aud claim for the id token. 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.
    included_client_audience str
    A client ID to include within the token's aud claim. Conflicts with included_custom_audience. One of included_client_audience or included_custom_audience must be specified.
    included_custom_audience str
    A custom audience to include within the token's aud claim. Conflicts with included_client_audience. One of included_client_audience or included_custom_audience 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 audience should be included in the aud claim for the id token. Defaults to true.
    addToIdToken Boolean
    Indicates if the audience should be included in the aud claim for the id token. 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.
    includedClientAudience String
    A client ID to include within the token's aud claim. Conflicts with included_custom_audience. One of included_client_audience or included_custom_audience must be specified.
    includedCustomAudience String
    A custom audience to include within the token's aud claim. Conflicts with included_client_audience. One of included_client_audience or included_custom_audience 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 AudienceProtocolMapper 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 AudienceProtocolMapper Resource

    Get an existing AudienceProtocolMapper 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?: AudienceProtocolMapperState, opts?: CustomResourceOptions): AudienceProtocolMapper
    @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,
        client_id: Optional[str] = None,
        client_scope_id: Optional[str] = None,
        included_client_audience: Optional[str] = None,
        included_custom_audience: Optional[str] = None,
        name: Optional[str] = None,
        realm_id: Optional[str] = None) -> AudienceProtocolMapper
    func GetAudienceProtocolMapper(ctx *Context, name string, id IDInput, state *AudienceProtocolMapperState, opts ...ResourceOption) (*AudienceProtocolMapper, error)
    public static AudienceProtocolMapper Get(string name, Input<string> id, AudienceProtocolMapperState? state, CustomResourceOptions? opts = null)
    public static AudienceProtocolMapper get(String name, Output<String> id, AudienceProtocolMapperState state, CustomResourceOptions options)
    resources:  _:    type: keycloak:openid:AudienceProtocolMapper    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 audience should be included in the aud claim for the id token. Defaults to true.
    AddToIdToken bool
    Indicates if the audience should be included in the aud claim for the id token. 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.
    IncludedClientAudience string
    A client ID to include within the token's aud claim. Conflicts with included_custom_audience. One of included_client_audience or included_custom_audience must be specified.
    IncludedCustomAudience string
    A custom audience to include within the token's aud claim. Conflicts with included_client_audience. One of included_client_audience or included_custom_audience 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 audience should be included in the aud claim for the id token. Defaults to true.
    AddToIdToken bool
    Indicates if the audience should be included in the aud claim for the id token. 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.
    IncludedClientAudience string
    A client ID to include within the token's aud claim. Conflicts with included_custom_audience. One of included_client_audience or included_custom_audience must be specified.
    IncludedCustomAudience string
    A custom audience to include within the token's aud claim. Conflicts with included_client_audience. One of included_client_audience or included_custom_audience 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 audience should be included in the aud claim for the id token. Defaults to true.
    addToIdToken Boolean
    Indicates if the audience should be included in the aud claim for the id token. 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.
    includedClientAudience String
    A client ID to include within the token's aud claim. Conflicts with included_custom_audience. One of included_client_audience or included_custom_audience must be specified.
    includedCustomAudience String
    A custom audience to include within the token's aud claim. Conflicts with included_client_audience. One of included_client_audience or included_custom_audience 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 audience should be included in the aud claim for the id token. Defaults to true.
    addToIdToken boolean
    Indicates if the audience should be included in the aud claim for the id token. 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.
    includedClientAudience string
    A client ID to include within the token's aud claim. Conflicts with included_custom_audience. One of included_client_audience or included_custom_audience must be specified.
    includedCustomAudience string
    A custom audience to include within the token's aud claim. Conflicts with included_client_audience. One of included_client_audience or included_custom_audience 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 audience should be included in the aud claim for the id token. Defaults to true.
    add_to_id_token bool
    Indicates if the audience should be included in the aud claim for the id token. 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.
    included_client_audience str
    A client ID to include within the token's aud claim. Conflicts with included_custom_audience. One of included_client_audience or included_custom_audience must be specified.
    included_custom_audience str
    A custom audience to include within the token's aud claim. Conflicts with included_client_audience. One of included_client_audience or included_custom_audience 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 audience should be included in the aud claim for the id token. Defaults to true.
    addToIdToken Boolean
    Indicates if the audience should be included in the aud claim for the id token. 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.
    includedClientAudience String
    A client ID to include within the token's aud claim. Conflicts with included_custom_audience. One of included_client_audience or included_custom_audience must be specified.
    includedCustomAudience String
    A custom audience to include within the token's aud claim. Conflicts with included_client_audience. One of included_client_audience or included_custom_audience 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}}

    Example:

    bash

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

    $ pulumi import keycloak:openid/audienceProtocolMapper:AudienceProtocolMapper audience_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.2.1 published on Monday, Feb 3, 2025 by Pulumi
    pulumi/pulumi-keycloak