keycloak.RealmUserProfile
Allows for managing Realm User Profiles within Keycloak.
A user profile defines a schema for representing user attributes and how they are managed within a realm. This is a preview feature, hence not fully supported and disabled by default. To enable it, start the server with one of the following flags:
- WildFly distribution:
-Dkeycloak.profile.feature.declarative_user_profile=enabled - Quarkus distribution:
--features=previewor--features=declarative-user-profile
The realm linked to the keycloak.RealmUserProfile resource must have the user profile feature enabled.
It can be done via the administration UI, or by setting the userProfileEnabled realm attribute to true.
Example Usage
using System.Collections.Generic;
using System.Text.Json;
using Pulumi;
using Keycloak = Pulumi.Keycloak;
return await Deployment.RunAsync(() =>
{
var realm = new Keycloak.Realm("realm", new()
{
RealmName = "my-realm",
Attributes =
{
{ "userProfileEnabled", true },
},
});
var userprofile = new Keycloak.RealmUserProfile("userprofile", new()
{
RealmId = keycloak_realm.My_realm.Id,
Attributes = new[]
{
new Keycloak.Inputs.RealmUserProfileAttributeArgs
{
Name = "field1",
DisplayName = "Field 1",
Group = "group1",
EnabledWhenScopes = new[]
{
"offline_access",
},
RequiredForRoles = new[]
{
"user",
},
RequiredForScopes = new[]
{
"offline_access",
},
Permissions = new Keycloak.Inputs.RealmUserProfileAttributePermissionsArgs
{
Views = new[]
{
"admin",
"user",
},
Edits = new[]
{
"admin",
"user",
},
},
Validators = new[]
{
new Keycloak.Inputs.RealmUserProfileAttributeValidatorArgs
{
Name = "person-name-prohibited-characters",
},
new Keycloak.Inputs.RealmUserProfileAttributeValidatorArgs
{
Name = "pattern",
Config =
{
{ "pattern", "^[a-z]+$" },
{ "error-message", "Nope" },
},
},
},
Annotations =
{
{ "foo", "bar" },
},
},
new Keycloak.Inputs.RealmUserProfileAttributeArgs
{
Name = "field2",
Validators = new[]
{
new Keycloak.Inputs.RealmUserProfileAttributeValidatorArgs
{
Name = "options",
Config =
{
{ "options", JsonSerializer.Serialize(new[]
{
"opt1",
}) },
},
},
},
Annotations =
{
{ "foo", JsonSerializer.Serialize(new Dictionary<string, object?>
{
["key"] = "val",
}) },
},
},
},
Groups = new[]
{
new Keycloak.Inputs.RealmUserProfileGroupArgs
{
Name = "group1",
DisplayHeader = "Group 1",
DisplayDescription = "A first group",
Annotations =
{
{ "foo", "bar" },
{ "foo2", JsonSerializer.Serialize(new Dictionary<string, object?>
{
["key"] = "val",
}) },
},
},
new Keycloak.Inputs.RealmUserProfileGroupArgs
{
Name = "group2",
},
},
});
});
package main
import (
"encoding/json"
"github.com/pulumi/pulumi-keycloak/sdk/v5/go/keycloak"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := keycloak.NewRealm(ctx, "realm", &keycloak.RealmArgs{
Realm: pulumi.String("my-realm"),
Attributes: pulumi.AnyMap{
"userProfileEnabled": pulumi.Any(true),
},
})
if err != nil {
return err
}
tmpJSON0, err := json.Marshal([]string{
"opt1",
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
tmpJSON1, err := json.Marshal(map[string]interface{}{
"key": "val",
})
if err != nil {
return err
}
json1 := string(tmpJSON1)
tmpJSON2, err := json.Marshal(map[string]interface{}{
"key": "val",
})
if err != nil {
return err
}
json2 := string(tmpJSON2)
_, err = keycloak.NewRealmUserProfile(ctx, "userprofile", &keycloak.RealmUserProfileArgs{
RealmId: pulumi.Any(keycloak_realm.My_realm.Id),
Attributes: keycloak.RealmUserProfileAttributeArray{
&keycloak.RealmUserProfileAttributeArgs{
Name: pulumi.String("field1"),
DisplayName: pulumi.String("Field 1"),
Group: pulumi.String("group1"),
EnabledWhenScopes: pulumi.StringArray{
pulumi.String("offline_access"),
},
RequiredForRoles: pulumi.StringArray{
pulumi.String("user"),
},
RequiredForScopes: pulumi.StringArray{
pulumi.String("offline_access"),
},
Permissions: &keycloak.RealmUserProfileAttributePermissionsArgs{
Views: pulumi.StringArray{
pulumi.String("admin"),
pulumi.String("user"),
},
Edits: pulumi.StringArray{
pulumi.String("admin"),
pulumi.String("user"),
},
},
Validators: keycloak.RealmUserProfileAttributeValidatorArray{
&keycloak.RealmUserProfileAttributeValidatorArgs{
Name: pulumi.String("person-name-prohibited-characters"),
},
&keycloak.RealmUserProfileAttributeValidatorArgs{
Name: pulumi.String("pattern"),
Config: pulumi.StringMap{
"pattern": pulumi.String("^[a-z]+$"),
"error-message": pulumi.String("Nope"),
},
},
},
Annotations: pulumi.StringMap{
"foo": pulumi.String("bar"),
},
},
&keycloak.RealmUserProfileAttributeArgs{
Name: pulumi.String("field2"),
Validators: keycloak.RealmUserProfileAttributeValidatorArray{
&keycloak.RealmUserProfileAttributeValidatorArgs{
Name: pulumi.String("options"),
Config: pulumi.StringMap{
"options": pulumi.String(json0),
},
},
},
Annotations: pulumi.StringMap{
"foo": pulumi.String(json1),
},
},
},
Groups: keycloak.RealmUserProfileGroupArray{
&keycloak.RealmUserProfileGroupArgs{
Name: pulumi.String("group1"),
DisplayHeader: pulumi.String("Group 1"),
DisplayDescription: pulumi.String("A first group"),
Annotations: pulumi.StringMap{
"foo": pulumi.String("bar"),
"foo2": pulumi.String(json2),
},
},
&keycloak.RealmUserProfileGroupArgs{
Name: pulumi.String("group2"),
},
},
})
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.RealmUserProfile;
import com.pulumi.keycloak.RealmUserProfileArgs;
import com.pulumi.keycloak.inputs.RealmUserProfileAttributeArgs;
import com.pulumi.keycloak.inputs.RealmUserProfileAttributePermissionsArgs;
import com.pulumi.keycloak.inputs.RealmUserProfileGroupArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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")
.attributes(Map.of("userProfileEnabled", true))
.build());
var userprofile = new RealmUserProfile("userprofile", RealmUserProfileArgs.builder()
.realmId(keycloak_realm.my_realm().id())
.attributes(
RealmUserProfileAttributeArgs.builder()
.name("field1")
.displayName("Field 1")
.group("group1")
.enabledWhenScopes("offline_access")
.requiredForRoles("user")
.requiredForScopes("offline_access")
.permissions(RealmUserProfileAttributePermissionsArgs.builder()
.views(
"admin",
"user")
.edits(
"admin",
"user")
.build())
.validators(
RealmUserProfileAttributeValidatorArgs.builder()
.name("person-name-prohibited-characters")
.build(),
RealmUserProfileAttributeValidatorArgs.builder()
.name("pattern")
.config(Map.ofEntries(
Map.entry("pattern", "^[a-z]+$"),
Map.entry("error-message", "Nope")
))
.build())
.annotations(Map.of("foo", "bar"))
.build(),
RealmUserProfileAttributeArgs.builder()
.name("field2")
.validators(RealmUserProfileAttributeValidatorArgs.builder()
.name("options")
.config(Map.of("options", serializeJson(
jsonArray("opt1"))))
.build())
.annotations(Map.of("foo", serializeJson(
jsonObject(
jsonProperty("key", "val")
))))
.build())
.groups(
RealmUserProfileGroupArgs.builder()
.name("group1")
.displayHeader("Group 1")
.displayDescription("A first group")
.annotations(Map.ofEntries(
Map.entry("foo", "bar"),
Map.entry("foo2", serializeJson(
jsonObject(
jsonProperty("key", "val")
)))
))
.build(),
RealmUserProfileGroupArgs.builder()
.name("group2")
.build())
.build());
}
}
import pulumi
import json
import pulumi_keycloak as keycloak
realm = keycloak.Realm("realm",
realm="my-realm",
attributes={
"userProfileEnabled": True,
})
userprofile = keycloak.RealmUserProfile("userprofile",
realm_id=keycloak_realm["my_realm"]["id"],
attributes=[
keycloak.RealmUserProfileAttributeArgs(
name="field1",
display_name="Field 1",
group="group1",
enabled_when_scopes=["offline_access"],
required_for_roles=["user"],
required_for_scopes=["offline_access"],
permissions=keycloak.RealmUserProfileAttributePermissionsArgs(
views=[
"admin",
"user",
],
edits=[
"admin",
"user",
],
),
validators=[
keycloak.RealmUserProfileAttributeValidatorArgs(
name="person-name-prohibited-characters",
),
keycloak.RealmUserProfileAttributeValidatorArgs(
name="pattern",
config={
"pattern": "^[a-z]+$",
"error-message": "Nope",
},
),
],
annotations={
"foo": "bar",
},
),
keycloak.RealmUserProfileAttributeArgs(
name="field2",
validators=[keycloak.RealmUserProfileAttributeValidatorArgs(
name="options",
config={
"options": json.dumps(["opt1"]),
},
)],
annotations={
"foo": json.dumps({
"key": "val",
}),
},
),
],
groups=[
keycloak.RealmUserProfileGroupArgs(
name="group1",
display_header="Group 1",
display_description="A first group",
annotations={
"foo": "bar",
"foo2": json.dumps({
"key": "val",
}),
},
),
keycloak.RealmUserProfileGroupArgs(
name="group2",
),
])
import * as pulumi from "@pulumi/pulumi";
import * as keycloak from "@pulumi/keycloak";
const realm = new keycloak.Realm("realm", {
realm: "my-realm",
attributes: {
userProfileEnabled: true,
},
});
const userprofile = new keycloak.RealmUserProfile("userprofile", {
realmId: keycloak_realm.my_realm.id,
attributes: [
{
name: "field1",
displayName: "Field 1",
group: "group1",
enabledWhenScopes: ["offline_access"],
requiredForRoles: ["user"],
requiredForScopes: ["offline_access"],
permissions: {
views: [
"admin",
"user",
],
edits: [
"admin",
"user",
],
},
validators: [
{
name: "person-name-prohibited-characters",
},
{
name: "pattern",
config: {
pattern: "^[a-z]+$",
"error-message": "Nope",
},
},
],
annotations: {
foo: "bar",
},
},
{
name: "field2",
validators: [{
name: "options",
config: {
options: JSON.stringify(["opt1"]),
},
}],
annotations: {
foo: JSON.stringify({
key: "val",
}),
},
},
],
groups: [
{
name: "group1",
displayHeader: "Group 1",
displayDescription: "A first group",
annotations: {
foo: "bar",
foo2: JSON.stringify({
key: "val",
}),
},
},
{
name: "group2",
},
],
});
resources:
realm:
type: keycloak:Realm
properties:
realm: my-realm
attributes:
userProfileEnabled: true
userprofile:
type: keycloak:RealmUserProfile
properties:
realmId: ${keycloak_realm.my_realm.id}
attributes:
- name: field1
displayName: Field 1
group: group1
enabledWhenScopes:
- offline_access
requiredForRoles:
- user
requiredForScopes:
- offline_access
permissions:
views:
- admin
- user
edits:
- admin
- user
validators:
- name: person-name-prohibited-characters
- name: pattern
config:
pattern: ^[a-z]+$
error-message: Nope
annotations:
foo: bar
- name: field2
validators:
- name: options
config:
options:
fn::toJSON:
- opt1
annotations:
foo:
fn::toJSON:
key: val
groups:
- name: group1
displayHeader: Group 1
displayDescription: A first group
annotations:
foo: bar
foo2:
fn::toJSON:
key: val
- name: group2
Create RealmUserProfile Resource
new RealmUserProfile(name: string, args: RealmUserProfileArgs, opts?: CustomResourceOptions);@overload
def RealmUserProfile(resource_name: str,
opts: Optional[ResourceOptions] = None,
attributes: Optional[Sequence[RealmUserProfileAttributeArgs]] = None,
groups: Optional[Sequence[RealmUserProfileGroupArgs]] = None,
realm_id: Optional[str] = None)
@overload
def RealmUserProfile(resource_name: str,
args: RealmUserProfileArgs,
opts: Optional[ResourceOptions] = None)func NewRealmUserProfile(ctx *Context, name string, args RealmUserProfileArgs, opts ...ResourceOption) (*RealmUserProfile, error)public RealmUserProfile(string name, RealmUserProfileArgs args, CustomResourceOptions? opts = null)
public RealmUserProfile(String name, RealmUserProfileArgs args)
public RealmUserProfile(String name, RealmUserProfileArgs args, CustomResourceOptions options)
type: keycloak:RealmUserProfile
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RealmUserProfileArgs
- 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 RealmUserProfileArgs
- 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 RealmUserProfileArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RealmUserProfileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RealmUserProfileArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
RealmUserProfile 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 RealmUserProfile resource accepts the following input properties:
- Realm
Id string The ID of the realm the user profile applies to.
- Attributes
List<Realm
User Profile Attribute Args> An ordered list of attributes.
- Groups
List<Realm
User Profile Group Args> A list of groups.
- Realm
Id string The ID of the realm the user profile applies to.
- Attributes
[]Realm
User Profile Attribute Args An ordered list of attributes.
- Groups
[]Realm
User Profile Group Args A list of groups.
- realm
Id String The ID of the realm the user profile applies to.
- attributes
List<Realm
User Profile Attribute Args> An ordered list of attributes.
- groups
List<Realm
User Profile Group Args> A list of groups.
- realm
Id string The ID of the realm the user profile applies to.
- attributes
Realm
User Profile Attribute Args[] An ordered list of attributes.
- groups
Realm
User Profile Group Args[] A list of groups.
- realm_
id str The ID of the realm the user profile applies to.
- attributes
Sequence[Realm
User Profile Attribute Args] An ordered list of attributes.
- groups
Sequence[Realm
User Profile Group Args] A list of groups.
- realm
Id String The ID of the realm the user profile applies to.
- attributes List<Property Map>
An ordered list of attributes.
- groups List<Property Map>
A list of groups.
Outputs
All input properties are implicitly available as output properties. Additionally, the RealmUserProfile 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 RealmUserProfile Resource
Get an existing RealmUserProfile 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?: RealmUserProfileState, opts?: CustomResourceOptions): RealmUserProfile@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
attributes: Optional[Sequence[RealmUserProfileAttributeArgs]] = None,
groups: Optional[Sequence[RealmUserProfileGroupArgs]] = None,
realm_id: Optional[str] = None) -> RealmUserProfilefunc GetRealmUserProfile(ctx *Context, name string, id IDInput, state *RealmUserProfileState, opts ...ResourceOption) (*RealmUserProfile, error)public static RealmUserProfile Get(string name, Input<string> id, RealmUserProfileState? state, CustomResourceOptions? opts = null)public static RealmUserProfile get(String name, Output<String> id, RealmUserProfileState 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.
- Attributes
List<Realm
User Profile Attribute Args> An ordered list of attributes.
- Groups
List<Realm
User Profile Group Args> A list of groups.
- Realm
Id string The ID of the realm the user profile applies to.
- Attributes
[]Realm
User Profile Attribute Args An ordered list of attributes.
- Groups
[]Realm
User Profile Group Args A list of groups.
- Realm
Id string The ID of the realm the user profile applies to.
- attributes
List<Realm
User Profile Attribute Args> An ordered list of attributes.
- groups
List<Realm
User Profile Group Args> A list of groups.
- realm
Id String The ID of the realm the user profile applies to.
- attributes
Realm
User Profile Attribute Args[] An ordered list of attributes.
- groups
Realm
User Profile Group Args[] A list of groups.
- realm
Id string The ID of the realm the user profile applies to.
- attributes
Sequence[Realm
User Profile Attribute Args] An ordered list of attributes.
- groups
Sequence[Realm
User Profile Group Args] A list of groups.
- realm_
id str The ID of the realm the user profile applies to.
- attributes List<Property Map>
An ordered list of attributes.
- groups List<Property Map>
A list of groups.
- realm
Id String The ID of the realm the user profile applies to.
Supporting Types
RealmUserProfileAttribute
- Name string
The name of the attribute.
- Annotations Dictionary<string, string>
A map of annotations for the attribute. Values can be a String or a json object.
- Display
Name string The display name of the attribute.
- Enabled
When List<string>Scopes A list of scopes. The attribute will only be enabled when these scopes are requested by clients.
- Group string
A list of groups.
- Permissions
Realm
User Profile Attribute Permissions The permissions configuration information.
- Required
For List<string>Roles A list of roles for which the attribute will be required.
- Required
For List<string>Scopes A list of scopes for which the attribute will be required.
- Validators
List<Realm
User Profile Attribute Validator> A list of validators for the attribute.
- Name string
The name of the attribute.
- Annotations map[string]string
A map of annotations for the attribute. Values can be a String or a json object.
- Display
Name string The display name of the attribute.
- Enabled
When []stringScopes A list of scopes. The attribute will only be enabled when these scopes are requested by clients.
- Group string
A list of groups.
- Permissions
Realm
User Profile Attribute Permissions The permissions configuration information.
- Required
For []stringRoles A list of roles for which the attribute will be required.
- Required
For []stringScopes A list of scopes for which the attribute will be required.
- Validators
[]Realm
User Profile Attribute Validator A list of validators for the attribute.
- name String
The name of the attribute.
- annotations Map<String,String>
A map of annotations for the attribute. Values can be a String or a json object.
- display
Name String The display name of the attribute.
- enabled
When List<String>Scopes A list of scopes. The attribute will only be enabled when these scopes are requested by clients.
- group String
A list of groups.
- permissions
Realm
User Profile Attribute Permissions The permissions configuration information.
- required
For List<String>Roles A list of roles for which the attribute will be required.
- required
For List<String>Scopes A list of scopes for which the attribute will be required.
- validators
List<Realm
User Profile Attribute Validator> A list of validators for the attribute.
- name string
The name of the attribute.
- annotations {[key: string]: string}
A map of annotations for the attribute. Values can be a String or a json object.
- display
Name string The display name of the attribute.
- enabled
When string[]Scopes A list of scopes. The attribute will only be enabled when these scopes are requested by clients.
- group string
A list of groups.
- permissions
Realm
User Profile Attribute Permissions The permissions configuration information.
- required
For string[]Roles A list of roles for which the attribute will be required.
- required
For string[]Scopes A list of scopes for which the attribute will be required.
- validators
Realm
User Profile Attribute Validator[] A list of validators for the attribute.
- name str
The name of the attribute.
- annotations Mapping[str, str]
A map of annotations for the attribute. Values can be a String or a json object.
- display_
name str The display name of the attribute.
- enabled_
when_ Sequence[str]scopes A list of scopes. The attribute will only be enabled when these scopes are requested by clients.
- group str
A list of groups.
- permissions
Realm
User Profile Attribute Permissions The permissions configuration information.
- required_
for_ Sequence[str]roles A list of roles for which the attribute will be required.
- required_
for_ Sequence[str]scopes A list of scopes for which the attribute will be required.
- validators
Sequence[Realm
User Profile Attribute Validator] A list of validators for the attribute.
- name String
The name of the attribute.
- annotations Map<String>
A map of annotations for the attribute. Values can be a String or a json object.
- display
Name String The display name of the attribute.
- enabled
When List<String>Scopes A list of scopes. The attribute will only be enabled when these scopes are requested by clients.
- group String
A list of groups.
- permissions Property Map
The permissions configuration information.
- required
For List<String>Roles A list of roles for which the attribute will be required.
- required
For List<String>Scopes A list of scopes for which the attribute will be required.
- validators List<Property Map>
A list of validators for the attribute.
RealmUserProfileAttributePermissions
RealmUserProfileAttributeValidator
RealmUserProfileGroup
- Name string
The name of the attribute.
- Annotations Dictionary<string, string>
A map of annotations for the attribute. Values can be a String or a json object.
- Display
Description string The display description of the group.
- Display
Header string The display header of the group.
- Name string
The name of the attribute.
- Annotations map[string]string
A map of annotations for the attribute. Values can be a String or a json object.
- Display
Description string The display description of the group.
- Display
Header string The display header of the group.
- name String
The name of the attribute.
- annotations Map<String,String>
A map of annotations for the attribute. Values can be a String or a json object.
- display
Description String The display description of the group.
- display
Header String The display header of the group.
- name string
The name of the attribute.
- annotations {[key: string]: string}
A map of annotations for the attribute. Values can be a String or a json object.
- display
Description string The display description of the group.
- display
Header string The display header of the group.
- name str
The name of the attribute.
- annotations Mapping[str, str]
A map of annotations for the attribute. Values can be a String or a json object.
- display_
description str The display description of the group.
- display_
header str The display header of the group.
- name String
The name of the attribute.
- annotations Map<String>
A map of annotations for the attribute. Values can be a String or a json object.
- display
Description String The display description of the group.
- display
Header String The display header of the group.
Import
This resource currently does not support importing.
Package Details
- Repository
- Keycloak pulumi/pulumi-keycloak
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
keycloakTerraform Provider.