Docs Packages
  1. Packages
  2. Keycloak
  3. API Docs
  4. openid
  5. AudienceResolveProtocolMapper
Keycloak v5.3.2 published on Friday, May 10, 2024 by Pulumi
pulumi/pulumi-keycloak

keycloak.openid.AudienceResolveProtocolMapper

Explore with Pulumi AI

keycloak logo
Keycloak v5.3.2 published on Friday, May 10, 2024 by Pulumi
pulumi/pulumi-keycloak

    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)

    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.AudienceResolveProtocolMapper("audience_mapper", {
    realmId: realm.id,
    clientId: openidClient.id,
    name: "my-audience-resolve-mapper",
});

    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.AudienceResolveProtocolMapper("audience_mapper",
    realm_id=realm.id,
    client_id=openid_client.id,
    name="my-audience-resolve-mapper")

    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, "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.NewAudienceResolveProtocolMapper(ctx, "audience_mapper", &openid.AudienceResolveProtocolMapperArgs{
			RealmId:  realm.ID(),
			ClientId: openidClient.ID(),
			Name:     pulumi.String("my-audience-resolve-mapper"),
		})
		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.AudienceResolveProtocolMapper("audience_mapper", new()
    {
        RealmId = realm.Id,
        ClientId = openidClient.Id,
        Name = "my-audience-resolve-mapper",
    });

});

    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.AudienceResolveProtocolMapper;
import com.pulumi.keycloak.openid.AudienceResolveProtocolMapperArgs;
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 AudienceResolveProtocolMapper("audienceMapper", AudienceResolveProtocolMapperArgs.builder()        
            .realmId(realm.id())
            .clientId(openidClient.id())
            .name("my-audience-resolve-mapper")
            .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:AudienceResolveProtocolMapper
    name: audience_mapper
    properties:
      realmId: ${realm.id}
      clientId: ${openidClient.id}
      name: my-audience-resolve-mapper

    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,
});

    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)

    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, "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(),
		})
		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,
    });

});

    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())
            .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}

    Create AudienceResolveProtocolMapper Resource

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

    Constructor syntax

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

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

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

    example, err := openid.NewAudienceResolveProtocolMapper(ctx, "audienceResolveProtocolMapperResource", &openid.AudienceResolveProtocolMapperArgs{
	RealmId:       pulumi.String("string"),
	ClientId:      pulumi.String("string"),
	ClientScopeId: pulumi.String("string"),
	Name:          pulumi.String("string"),
})

    var audienceResolveProtocolMapperResource = new AudienceResolveProtocolMapper("audienceResolveProtocolMapperResource", AudienceResolveProtocolMapperArgs.builder()
    .realmId("string")
    .clientId("string")
    .clientScopeId("string")
    .name("string")
    .build());

    audience_resolve_protocol_mapper_resource = keycloak.openid.AudienceResolveProtocolMapper("audienceResolveProtocolMapperResource",
    realm_id="string",
    client_id="string",
    client_scope_id="string",
    name="string")

    const audienceResolveProtocolMapperResource = new keycloak.openid.AudienceResolveProtocolMapper("audienceResolveProtocolMapperResource", {
    realmId: "string",
    clientId: "string",
    clientScopeId: "string",
    name: "string",
});

    type: keycloak:openid:AudienceResolveProtocolMapper
properties:
    clientId: string
    clientScopeId: string
    name: string
    realmId: string

    AudienceResolveProtocolMapper 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 AudienceResolveProtocolMapper 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 AudienceResolveProtocolMapper 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 AudienceResolveProtocolMapper Resource

    Get an existing AudienceResolveProtocolMapper 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?: AudienceResolveProtocolMapperState, opts?: CustomResourceOptions): AudienceResolveProtocolMapper
    @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) -> AudienceResolveProtocolMapper
    func GetAudienceResolveProtocolMapper(ctx *Context, name string, id IDInput, state *AudienceResolveProtocolMapperState, opts ...ResourceOption) (*AudienceResolveProtocolMapper, error)
    public static AudienceResolveProtocolMapper Get(string name, Input<string> id, AudienceResolveProtocolMapperState? state, CustomResourceOptions? opts = null)
    public static AudienceResolveProtocolMapper get(String name, Output<String> id, AudienceResolveProtocolMapperState 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}}

    Example:

    bash

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

    $ pulumi import keycloak:openid/audienceResolveProtocolMapper:AudienceResolveProtocolMapper 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 v5.3.2 published on Friday, May 10, 2024 by Pulumi
    pulumi/pulumi-keycloak