Allows for creating and managing sub protocol mappers within Keycloak.
Sub protocol mappers add the Subject (sub) claim to tokens. The sub claim contains the user ID and is a standard claim in OpenID Connect tokens.
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", {
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 subMapper = new keycloak.openid.SubProtocolMapper("sub_mapper", {
realmId: realm.id,
clientId: openidClient.id,
name: "sub-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"])
sub_mapper = keycloak.openid.SubProtocolMapper("sub_mapper",
realm_id=realm.id,
client_id=openid_client.id,
name="sub-mapper")
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.NewSubProtocolMapper(ctx, "sub_mapper", &openid.SubProtocolMapperArgs{
RealmId: realm.ID(),
ClientId: openidClient.ID(),
Name: pulumi.String("sub-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 subMapper = new Keycloak.OpenId.SubProtocolMapper("sub_mapper", new()
{
RealmId = realm.Id,
ClientId = openidClient.Id,
Name = "sub-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.SubProtocolMapper;
import com.pulumi.keycloak.openid.SubProtocolMapperArgs;
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 subMapper = new SubProtocolMapper("subMapper", SubProtocolMapperArgs.builder()
.realmId(realm.id())
.clientId(openidClient.id())
.name("sub-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
subMapper:
type: keycloak:openid:SubProtocolMapper
name: sub_mapper
properties:
realmId: ${realm.id}
clientId: ${openidClient.id}
name: sub-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: "client-scope",
});
const subMapper = new keycloak.openid.SubProtocolMapper("sub_mapper", {
realmId: realm.id,
clientScopeId: clientScope.id,
name: "sub-mapper",
});
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="client-scope")
sub_mapper = keycloak.openid.SubProtocolMapper("sub_mapper",
realm_id=realm.id,
client_scope_id=client_scope.id,
name="sub-mapper")
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("client-scope"),
})
if err != nil {
return err
}
_, err = openid.NewSubProtocolMapper(ctx, "sub_mapper", &openid.SubProtocolMapperArgs{
RealmId: realm.ID(),
ClientScopeId: clientScope.ID(),
Name: pulumi.String("sub-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 clientScope = new Keycloak.OpenId.ClientScope("client_scope", new()
{
RealmId = realm.Id,
Name = "client-scope",
});
var subMapper = new Keycloak.OpenId.SubProtocolMapper("sub_mapper", new()
{
RealmId = realm.Id,
ClientScopeId = clientScope.Id,
Name = "sub-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.ClientScope;
import com.pulumi.keycloak.openid.ClientScopeArgs;
import com.pulumi.keycloak.openid.SubProtocolMapper;
import com.pulumi.keycloak.openid.SubProtocolMapperArgs;
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("client-scope")
.build());
var subMapper = new SubProtocolMapper("subMapper", SubProtocolMapperArgs.builder()
.realmId(realm.id())
.clientScopeId(clientScope.id())
.name("sub-mapper")
.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: client-scope
subMapper:
type: keycloak:openid:SubProtocolMapper
name: sub_mapper
properties:
realmId: ${realm.id}
clientScopeId: ${clientScope.id}
name: sub-mapper
Create SubProtocolMapper Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SubProtocolMapper(name: string, args: SubProtocolMapperArgs, opts?: CustomResourceOptions);@overload
def SubProtocolMapper(resource_name: str,
args: SubProtocolMapperArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SubProtocolMapper(resource_name: str,
opts: Optional[ResourceOptions] = None,
realm_id: Optional[str] = None,
add_to_access_token: Optional[bool] = None,
add_to_token_introspection: Optional[bool] = None,
client_id: Optional[str] = None,
client_scope_id: Optional[str] = None,
name: Optional[str] = None)func NewSubProtocolMapper(ctx *Context, name string, args SubProtocolMapperArgs, opts ...ResourceOption) (*SubProtocolMapper, error)public SubProtocolMapper(string name, SubProtocolMapperArgs args, CustomResourceOptions? opts = null)
public SubProtocolMapper(String name, SubProtocolMapperArgs args)
public SubProtocolMapper(String name, SubProtocolMapperArgs args, CustomResourceOptions options)
type: keycloak:openid:SubProtocolMapper
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 SubProtocolMapperArgs
- 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 SubProtocolMapperArgs
- 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 SubProtocolMapperArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SubProtocolMapperArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SubProtocolMapperArgs
- 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 subProtocolMapperResource = new Keycloak.OpenId.SubProtocolMapper("subProtocolMapperResource", new()
{
RealmId = "string",
AddToAccessToken = false,
AddToTokenIntrospection = false,
ClientId = "string",
ClientScopeId = "string",
Name = "string",
});
example, err := openid.NewSubProtocolMapper(ctx, "subProtocolMapperResource", &openid.SubProtocolMapperArgs{
RealmId: pulumi.String("string"),
AddToAccessToken: pulumi.Bool(false),
AddToTokenIntrospection: pulumi.Bool(false),
ClientId: pulumi.String("string"),
ClientScopeId: pulumi.String("string"),
Name: pulumi.String("string"),
})
var subProtocolMapperResource = new SubProtocolMapper("subProtocolMapperResource", SubProtocolMapperArgs.builder()
.realmId("string")
.addToAccessToken(false)
.addToTokenIntrospection(false)
.clientId("string")
.clientScopeId("string")
.name("string")
.build());
sub_protocol_mapper_resource = keycloak.openid.SubProtocolMapper("subProtocolMapperResource",
realm_id="string",
add_to_access_token=False,
add_to_token_introspection=False,
client_id="string",
client_scope_id="string",
name="string")
const subProtocolMapperResource = new keycloak.openid.SubProtocolMapper("subProtocolMapperResource", {
realmId: "string",
addToAccessToken: false,
addToTokenIntrospection: false,
clientId: "string",
clientScopeId: "string",
name: "string",
});
type: keycloak:openid:SubProtocolMapper
properties:
addToAccessToken: false
addToTokenIntrospection: false
clientId: string
clientScopeId: string
name: string
realmId: string
SubProtocolMapper 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 SubProtocolMapper resource accepts the following input properties:
- Realm
Id string - The realm this protocol mapper exists within.
- Add
To boolAccess Token - Indicates if the sub claim should be added to the access token. Defaults to
true. - Add
To boolToken Introspection - Indicates if the sub claim should be added to the token introspection response. Defaults to
true. - Client
Id string - The client this protocol mapper should be attached to. Conflicts with
client_scope_id. One ofclient_idorclient_scope_idmust be specified. - Client
Scope stringId - The client scope this protocol mapper should be attached to. Conflicts with
client_id. One ofclient_idorclient_scope_idmust be specified. - Name string
- The display name of this protocol mapper in the GUI.
- Realm
Id string - The realm this protocol mapper exists within.
- Add
To boolAccess Token - Indicates if the sub claim should be added to the access token. Defaults to
true. - Add
To boolToken Introspection - Indicates if the sub claim should be added to the token introspection response. Defaults to
true. - Client
Id string - The client this protocol mapper should be attached to. Conflicts with
client_scope_id. One ofclient_idorclient_scope_idmust be specified. - Client
Scope stringId - The client scope this protocol mapper should be attached to. Conflicts with
client_id. One ofclient_idorclient_scope_idmust be specified. - Name string
- The display name of this protocol mapper in the GUI.
- realm
Id String - The realm this protocol mapper exists within.
- add
To BooleanAccess Token - Indicates if the sub claim should be added to the access token. Defaults to
true. - add
To BooleanToken Introspection - Indicates if the sub claim should be added to the token introspection response. Defaults to
true. - client
Id String - The client this protocol mapper should be attached to. Conflicts with
client_scope_id. One ofclient_idorclient_scope_idmust be specified. - client
Scope StringId - The client scope this protocol mapper should be attached to. Conflicts with
client_id. One ofclient_idorclient_scope_idmust be specified. - name String
- The display name of this protocol mapper in the GUI.
- realm
Id string - The realm this protocol mapper exists within.
- add
To booleanAccess Token - Indicates if the sub claim should be added to the access token. Defaults to
true. - add
To booleanToken Introspection - Indicates if the sub claim should be added to the token introspection response. Defaults to
true. - client
Id string - The client this protocol mapper should be attached to. Conflicts with
client_scope_id. One ofclient_idorclient_scope_idmust be specified. - client
Scope stringId - The client scope this protocol mapper should be attached to. Conflicts with
client_id. One ofclient_idorclient_scope_idmust 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_ boolaccess_ token - Indicates if the sub claim should be added to the access token. Defaults to
true. - add_
to_ booltoken_ introspection - Indicates if the sub claim should be added to the token introspection response. Defaults to
true. - client_
id str - The client this protocol mapper should be attached to. Conflicts with
client_scope_id. One ofclient_idorclient_scope_idmust be specified. - client_
scope_ strid - The client scope this protocol mapper should be attached to. Conflicts with
client_id. One ofclient_idorclient_scope_idmust be specified. - name str
- The display name of this protocol mapper in the GUI.
- realm
Id String - The realm this protocol mapper exists within.
- add
To BooleanAccess Token - Indicates if the sub claim should be added to the access token. Defaults to
true. - add
To BooleanToken Introspection - Indicates if the sub claim should be added to the token introspection response. Defaults to
true. - client
Id String - The client this protocol mapper should be attached to. Conflicts with
client_scope_id. One ofclient_idorclient_scope_idmust be specified. - client
Scope StringId - The client scope this protocol mapper should be attached to. Conflicts with
client_id. One ofclient_idorclient_scope_idmust 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 SubProtocolMapper 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 SubProtocolMapper Resource
Get an existing SubProtocolMapper 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?: SubProtocolMapperState, opts?: CustomResourceOptions): SubProtocolMapper@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
add_to_access_token: Optional[bool] = None,
add_to_token_introspection: Optional[bool] = None,
client_id: Optional[str] = None,
client_scope_id: Optional[str] = None,
name: Optional[str] = None,
realm_id: Optional[str] = None) -> SubProtocolMapperfunc GetSubProtocolMapper(ctx *Context, name string, id IDInput, state *SubProtocolMapperState, opts ...ResourceOption) (*SubProtocolMapper, error)public static SubProtocolMapper Get(string name, Input<string> id, SubProtocolMapperState? state, CustomResourceOptions? opts = null)public static SubProtocolMapper get(String name, Output<String> id, SubProtocolMapperState state, CustomResourceOptions options)resources: _: type: keycloak:openid:SubProtocolMapper 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.
- Add
To boolAccess Token - Indicates if the sub claim should be added to the access token. Defaults to
true. - Add
To boolToken Introspection - Indicates if the sub claim should be added to the token introspection response. Defaults to
true. - Client
Id string - The client this protocol mapper should be attached to. Conflicts with
client_scope_id. One ofclient_idorclient_scope_idmust be specified. - Client
Scope stringId - The client scope this protocol mapper should be attached to. Conflicts with
client_id. One ofclient_idorclient_scope_idmust be specified. - Name string
- The display name of this protocol mapper in the GUI.
- Realm
Id string - The realm this protocol mapper exists within.
- Add
To boolAccess Token - Indicates if the sub claim should be added to the access token. Defaults to
true. - Add
To boolToken Introspection - Indicates if the sub claim should be added to the token introspection response. Defaults to
true. - Client
Id string - The client this protocol mapper should be attached to. Conflicts with
client_scope_id. One ofclient_idorclient_scope_idmust be specified. - Client
Scope stringId - The client scope this protocol mapper should be attached to. Conflicts with
client_id. One ofclient_idorclient_scope_idmust be specified. - Name string
- The display name of this protocol mapper in the GUI.
- Realm
Id string - The realm this protocol mapper exists within.
- add
To BooleanAccess Token - Indicates if the sub claim should be added to the access token. Defaults to
true. - add
To BooleanToken Introspection - Indicates if the sub claim should be added to the token introspection response. Defaults to
true. - client
Id String - The client this protocol mapper should be attached to. Conflicts with
client_scope_id. One ofclient_idorclient_scope_idmust be specified. - client
Scope StringId - The client scope this protocol mapper should be attached to. Conflicts with
client_id. One ofclient_idorclient_scope_idmust be specified. - name String
- The display name of this protocol mapper in the GUI.
- realm
Id String - The realm this protocol mapper exists within.
- add
To booleanAccess Token - Indicates if the sub claim should be added to the access token. Defaults to
true. - add
To booleanToken Introspection - Indicates if the sub claim should be added to the token introspection response. Defaults to
true. - client
Id string - The client this protocol mapper should be attached to. Conflicts with
client_scope_id. One ofclient_idorclient_scope_idmust be specified. - client
Scope stringId - The client scope this protocol mapper should be attached to. Conflicts with
client_id. One ofclient_idorclient_scope_idmust be specified. - name string
- The display name of this protocol mapper in the GUI.
- realm
Id string - The realm this protocol mapper exists within.
- add_
to_ boolaccess_ token - Indicates if the sub claim should be added to the access token. Defaults to
true. - add_
to_ booltoken_ introspection - Indicates if the sub claim should be added to the token introspection response. Defaults to
true. - client_
id str - The client this protocol mapper should be attached to. Conflicts with
client_scope_id. One ofclient_idorclient_scope_idmust be specified. - client_
scope_ strid - The client scope this protocol mapper should be attached to. Conflicts with
client_id. One ofclient_idorclient_scope_idmust be specified. - name str
- The display name of this protocol mapper in the GUI.
- realm_
id str - The realm this protocol mapper exists within.
- add
To BooleanAccess Token - Indicates if the sub claim should be added to the access token. Defaults to
true. - add
To BooleanToken Introspection - Indicates if the sub claim should be added to the token introspection response. Defaults to
true. - client
Id String - The client this protocol mapper should be attached to. Conflicts with
client_scope_id. One ofclient_idorclient_scope_idmust be specified. - client
Scope StringId - The client scope this protocol mapper should be attached to. Conflicts with
client_id. One ofclient_idorclient_scope_idmust be specified. - name String
- The display name of this protocol mapper in the GUI.
- realm
Id 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/subProtocolMapper:SubProtocolMapper sub_mapper my-realm/client/a7202154-8793-4656-b655-1dd18c181e14/71602afa-f7d1-4788-8c49-ef8fd00af0f4
$ pulumi import keycloak:openid/subProtocolMapper:SubProtocolMapper sub_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
keycloakTerraform Provider.
