get Realm
This data source can be used to fetch properties of a Keycloak realm for usage with other resources.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as keycloak from "@pulumi/keycloak";
const realm = keycloak.getRealm({
realm: "my-realm",
});
// use the data source
const group = new keycloak.Role("group", {
realmId: realm.then(realm => realm.id),
name: "group",
});
Content copied to clipboard
import pulumi
import pulumi_keycloak as keycloak
realm = keycloak.get_realm(realm="my-realm")
# use the data source
group = keycloak.Role("group",
realm_id=realm.id,
name="group")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Keycloak = Pulumi.Keycloak;
return await Deployment.RunAsync(() =>
{
var realm = Keycloak.GetRealm.Invoke(new()
{
Realm = "my-realm",
});
// use the data source
var @group = new Keycloak.Role("group", new()
{
RealmId = realm.Apply(getRealmResult => getRealmResult.Id),
Name = "group",
});
});
Content copied to clipboard
package main
import (
"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 {
realm, err := keycloak.LookupRealm(ctx, &keycloak.LookupRealmArgs{
Realm: "my-realm",
}, nil)
if err != nil {
return err
}
// use the data source
_, err = keycloak.NewRole(ctx, "group", &keycloak.RoleArgs{
RealmId: pulumi.String(realm.Id),
Name: pulumi.String("group"),
})
if err != nil {
return err
}
return nil
})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.keycloak.KeycloakFunctions;
import com.pulumi.keycloak.inputs.GetRealmArgs;
import com.pulumi.keycloak.Role;
import com.pulumi.keycloak.RoleArgs;
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) {
final var realm = KeycloakFunctions.getRealm(GetRealmArgs.builder()
.realm("my-realm")
.build());
// use the data source
var group = new Role("group", RoleArgs.builder()
.realmId(realm.applyValue(getRealmResult -> getRealmResult.id()))
.name("group")
.build());
}
}
Content copied to clipboard
resources:
# use the data source
group:
type: keycloak:Role
properties:
realmId: ${realm.id}
name: group
variables:
realm:
fn::invoke:
Function: keycloak:getRealm
Arguments:
realm: my-realm
Content copied to clipboard
Return
A collection of values returned by getRealm.
Parameters
argument
A collection of arguments for invoking getRealm.
suspend fun getRealm(attributes: Map<String, String>? = null, defaultDefaultClientScopes: List<String>? = null, defaultOptionalClientScopes: List<String>? = null, displayNameHtml: String? = null, internationalizations: List<GetRealmInternationalization>? = null, otpPolicy: GetRealmOtpPolicy? = null, realm: String, securityDefenses: List<GetRealmSecurityDefense>? = null, smtpServers: List<GetRealmSmtpServer>? = null, webAuthnPasswordlessPolicy: GetRealmWebAuthnPasswordlessPolicy? = null, webAuthnPolicy: GetRealmWebAuthnPolicy? = null): GetRealmResult
Return
A collection of values returned by getRealm.
Parameters
attributes
default Default Client Scopes
default Optional Client Scopes
display Name Html
internationalizations
otp Policy
realm
The realm name.
security Defenses
smtp Servers
web Authn Passwordless Policy
web Authn Policy
See also
Return
A collection of values returned by getRealm.
Parameters
argument
Builder for com.pulumi.keycloak.kotlin.inputs.GetRealmPlainArgs.