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

keycloak.openid.AudienceResolveProtocolMappter

Explore with Pulumi AI

Allows for creating the “Audience Resolve” OIDC protocol mapper within Keycloak.

This protocol mapper is useful to avoid manual management of audiences, instead relying on the presence of client roles to imply which audiences are appropriate for the token. See the Keycloak docs for more details.

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 audienceMapper = new Keycloak.OpenId.AudienceResolveProtocolMappter("audienceMapper", 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.NewAudienceResolveProtocolMappter(ctx, "audienceMapper", &openid.AudienceResolveProtocolMappterArgs{
			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.AudienceResolveProtocolMappter;
import com.pulumi.keycloak.openid.AudienceResolveProtocolMappterArgs;
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 audienceMapper = new AudienceResolveProtocolMappter("audienceMapper", AudienceResolveProtocolMappterArgs.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"])
audience_mapper = keycloak.openid.AudienceResolveProtocolMappter("audienceMapper",
    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 audienceMapper = new keycloak.openid.AudienceResolveProtocolMappter("audienceMapper", {
    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
  audienceMapper:
    type: keycloak:openid:AudienceResolveProtocolMappter
    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 audienceMapper = new Keycloak.OpenId.AudienceProtocolMapper("audienceMapper", 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.NewAudienceProtocolMapper(ctx, "audienceMapper", &openid.AudienceProtocolMapperArgs{
			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.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())
            .build());

        var audienceMapper = new AudienceProtocolMapper("audienceMapper", AudienceProtocolMapperArgs.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)
audience_mapper = keycloak.openid.AudienceProtocolMapper("audienceMapper",
    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 audienceMapper = new keycloak.openid.AudienceProtocolMapper("audienceMapper", {
    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}
  audienceMapper:
    type: keycloak:openid:AudienceProtocolMapper
    properties:
      realmId: ${realm.id}
      clientScopeId: ${clientScope.id}

Create AudienceResolveProtocolMappter Resource

new AudienceResolveProtocolMappter(name: string, args: AudienceResolveProtocolMappterArgs, opts?: CustomResourceOptions);
@overload
def AudienceResolveProtocolMappter(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   client_id: Optional[str] = None,
                                   client_scope_id: Optional[str] = None,
                                   name: Optional[str] = None,
                                   realm_id: Optional[str] = None)
@overload
def AudienceResolveProtocolMappter(resource_name: str,
                                   args: AudienceResolveProtocolMappterArgs,
                                   opts: Optional[ResourceOptions] = None)
func NewAudienceResolveProtocolMappter(ctx *Context, name string, args AudienceResolveProtocolMappterArgs, opts ...ResourceOption) (*AudienceResolveProtocolMappter, error)
public AudienceResolveProtocolMappter(string name, AudienceResolveProtocolMappterArgs args, CustomResourceOptions? opts = null)
public AudienceResolveProtocolMappter(String name, AudienceResolveProtocolMappterArgs args)
public AudienceResolveProtocolMappter(String name, AudienceResolveProtocolMappterArgs args, CustomResourceOptions options)

type: keycloak:openid:AudienceResolveProtocolMappter
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AudienceResolveProtocolMappterArgs
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 AudienceResolveProtocolMappterArgs
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 AudienceResolveProtocolMappterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AudienceResolveProtocolMappterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AudienceResolveProtocolMappterArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

RealmId string

The realm this protocol mapper exists within.

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. Defaults to "audience resolve".

RealmId string

The realm this protocol mapper exists within.

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. Defaults to "audience resolve".

realmId String

The realm this protocol mapper exists within.

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. Defaults to "audience resolve".

realmId string

The realm this protocol mapper exists within.

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. Defaults to "audience resolve".

realm_id str

The realm this protocol mapper exists within.

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. Defaults to "audience resolve".

realmId String

The realm this protocol mapper exists within.

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. Defaults to "audience resolve".

Outputs

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

Get an existing AudienceResolveProtocolMappter 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?: AudienceResolveProtocolMappterState, opts?: CustomResourceOptions): AudienceResolveProtocolMappter
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_id: Optional[str] = None,
        client_scope_id: Optional[str] = None,
        name: Optional[str] = None,
        realm_id: Optional[str] = None) -> AudienceResolveProtocolMappter
func GetAudienceResolveProtocolMappter(ctx *Context, name string, id IDInput, state *AudienceResolveProtocolMappterState, opts ...ResourceOption) (*AudienceResolveProtocolMappter, error)
public static AudienceResolveProtocolMappter Get(string name, Input<string> id, AudienceResolveProtocolMappterState? state, CustomResourceOptions? opts = null)
public static AudienceResolveProtocolMappter get(String name, Output<String> id, AudienceResolveProtocolMappterState 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:
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. Defaults to "audience resolve".

RealmId string

The realm this protocol mapper exists within.

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. Defaults to "audience resolve".

RealmId string

The realm this protocol mapper exists within.

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. Defaults to "audience resolve".

realmId String

The realm this protocol mapper exists within.

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. Defaults to "audience resolve".

realmId string

The realm this protocol mapper exists within.

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. Defaults to "audience resolve".

realm_id str

The realm this protocol mapper exists within.

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. Defaults to "audience resolve".

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/audienceResolveProtocolMappter:AudienceResolveProtocolMappter audience_mapper my-realm/client/a7202154-8793-4656-b655-1dd18c181e14/71602afa-f7d1-4788-8c49-ef8fd00af0f4

 $ pulumi import keycloak:openid/audienceResolveProtocolMappter:AudienceResolveProtocolMappter audience_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.