1. Packages
  2. Keycloak Provider
  3. API Docs
  4. getRealm
Keycloak v6.2.2 published on Wednesday, Apr 9, 2025 by Pulumi

keycloak.getRealm

Explore with Pulumi AI

Keycloak v6.2.2 published on Wednesday, Apr 9, 2025 by Pulumi

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",
});
Copy
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")
Copy
package main

import (
	"github.com/pulumi/pulumi-keycloak/sdk/v6/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
	})
}
Copy
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",
    });

});
Copy
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.id())
            .name("group")
            .build());

    }
}
Copy
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
Copy

Using getRealm

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRealm(args: GetRealmArgs, opts?: InvokeOptions): Promise<GetRealmResult>
function getRealmOutput(args: GetRealmOutputArgs, opts?: InvokeOptions): Output<GetRealmResult>
Copy
def get_realm(attributes: Optional[Mapping[str, str]] = None,
              default_default_client_scopes: Optional[Sequence[str]] = None,
              default_optional_client_scopes: Optional[Sequence[str]] = None,
              display_name_html: Optional[str] = None,
              internationalizations: Optional[Sequence[GetRealmInternationalization]] = None,
              otp_policy: Optional[GetRealmOtpPolicy] = None,
              realm: Optional[str] = None,
              security_defenses: Optional[Sequence[GetRealmSecurityDefense]] = None,
              smtp_servers: Optional[Sequence[GetRealmSmtpServer]] = None,
              web_authn_passwordless_policy: Optional[GetRealmWebAuthnPasswordlessPolicy] = None,
              web_authn_policy: Optional[GetRealmWebAuthnPolicy] = None,
              opts: Optional[InvokeOptions] = None) -> GetRealmResult
def get_realm_output(attributes: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
              default_default_client_scopes: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
              default_optional_client_scopes: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
              display_name_html: Optional[pulumi.Input[str]] = None,
              internationalizations: Optional[pulumi.Input[Sequence[pulumi.Input[GetRealmInternationalizationArgs]]]] = None,
              otp_policy: Optional[pulumi.Input[GetRealmOtpPolicyArgs]] = None,
              realm: Optional[pulumi.Input[str]] = None,
              security_defenses: Optional[pulumi.Input[Sequence[pulumi.Input[GetRealmSecurityDefenseArgs]]]] = None,
              smtp_servers: Optional[pulumi.Input[Sequence[pulumi.Input[GetRealmSmtpServerArgs]]]] = None,
              web_authn_passwordless_policy: Optional[pulumi.Input[GetRealmWebAuthnPasswordlessPolicyArgs]] = None,
              web_authn_policy: Optional[pulumi.Input[GetRealmWebAuthnPolicyArgs]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetRealmResult]
Copy
func LookupRealm(ctx *Context, args *LookupRealmArgs, opts ...InvokeOption) (*LookupRealmResult, error)
func LookupRealmOutput(ctx *Context, args *LookupRealmOutputArgs, opts ...InvokeOption) LookupRealmResultOutput
Copy

> Note: This function is named LookupRealm in the Go SDK.

public static class GetRealm 
{
    public static Task<GetRealmResult> InvokeAsync(GetRealmArgs args, InvokeOptions? opts = null)
    public static Output<GetRealmResult> Invoke(GetRealmInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRealmResult> getRealm(GetRealmArgs args, InvokeOptions options)
public static Output<GetRealmResult> getRealm(GetRealmArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: keycloak:index/getRealm:getRealm
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

getRealm Result

The following output properties are available:

AccessCodeLifespan string
AccessCodeLifespanLogin string
AccessCodeLifespanUserAction string
AccessTokenLifespan string
AccessTokenLifespanForImplicitFlow string
AccountTheme string
ActionTokenGeneratedByAdminLifespan string
ActionTokenGeneratedByUserLifespan string
AdminTheme string
Attributes Dictionary<string, string>
BrowserFlow string
ClientAuthenticationFlow string
ClientSessionIdleTimeout string
ClientSessionMaxLifespan string
DefaultDefaultClientScopes List<string>
DefaultOptionalClientScopes List<string>
DefaultSignatureAlgorithm string
DirectGrantFlow string
DisplayName string
DockerAuthenticationFlow string
DuplicateEmailsAllowed bool
EditUsernameAllowed bool
EmailTheme string
Enabled bool
Id string
The provider-assigned unique ID for this managed resource.
InternalId string
Internationalizations List<GetRealmInternationalization>
LoginTheme string
LoginWithEmailAllowed bool
Oauth2DeviceCodeLifespan string
Oauth2DevicePollingInterval int
OfflineSessionIdleTimeout string
OfflineSessionMaxLifespan string
OfflineSessionMaxLifespanEnabled bool
OtpPolicy GetRealmOtpPolicy
PasswordPolicy string
Realm string
RefreshTokenMaxReuse int
RegistrationAllowed bool
RegistrationEmailAsUsername bool
RegistrationFlow string
RememberMe bool
ResetCredentialsFlow string
ResetPasswordAllowed bool
RevokeRefreshToken bool
SecurityDefenses List<GetRealmSecurityDefense>
SmtpServers List<GetRealmSmtpServer>
SslRequired string
SsoSessionIdleTimeout string
SsoSessionIdleTimeoutRememberMe string
SsoSessionMaxLifespan string
SsoSessionMaxLifespanRememberMe string
UserManagedAccess bool
VerifyEmail bool
WebAuthnPasswordlessPolicy GetRealmWebAuthnPasswordlessPolicy
WebAuthnPolicy GetRealmWebAuthnPolicy
DisplayNameHtml string
AccessCodeLifespan string
AccessCodeLifespanLogin string
AccessCodeLifespanUserAction string
AccessTokenLifespan string
AccessTokenLifespanForImplicitFlow string
AccountTheme string
ActionTokenGeneratedByAdminLifespan string
ActionTokenGeneratedByUserLifespan string
AdminTheme string
Attributes map[string]string
BrowserFlow string
ClientAuthenticationFlow string
ClientSessionIdleTimeout string
ClientSessionMaxLifespan string
DefaultDefaultClientScopes []string
DefaultOptionalClientScopes []string
DefaultSignatureAlgorithm string
DirectGrantFlow string
DisplayName string
DockerAuthenticationFlow string
DuplicateEmailsAllowed bool
EditUsernameAllowed bool
EmailTheme string
Enabled bool
Id string
The provider-assigned unique ID for this managed resource.
InternalId string
Internationalizations []GetRealmInternationalization
LoginTheme string
LoginWithEmailAllowed bool
Oauth2DeviceCodeLifespan string
Oauth2DevicePollingInterval int
OfflineSessionIdleTimeout string
OfflineSessionMaxLifespan string
OfflineSessionMaxLifespanEnabled bool
OtpPolicy GetRealmOtpPolicy
PasswordPolicy string
Realm string
RefreshTokenMaxReuse int
RegistrationAllowed bool
RegistrationEmailAsUsername bool
RegistrationFlow string
RememberMe bool
ResetCredentialsFlow string
ResetPasswordAllowed bool
RevokeRefreshToken bool
SecurityDefenses []GetRealmSecurityDefense
SmtpServers []GetRealmSmtpServer
SslRequired string
SsoSessionIdleTimeout string
SsoSessionIdleTimeoutRememberMe string
SsoSessionMaxLifespan string
SsoSessionMaxLifespanRememberMe string
UserManagedAccess bool
VerifyEmail bool
WebAuthnPasswordlessPolicy GetRealmWebAuthnPasswordlessPolicy
WebAuthnPolicy GetRealmWebAuthnPolicy
DisplayNameHtml string
accessCodeLifespan String
accessCodeLifespanLogin String
accessCodeLifespanUserAction String
accessTokenLifespan String
accessTokenLifespanForImplicitFlow String
accountTheme String
actionTokenGeneratedByAdminLifespan String
actionTokenGeneratedByUserLifespan String
adminTheme String
attributes Map<String,String>
browserFlow String
clientAuthenticationFlow String
clientSessionIdleTimeout String
clientSessionMaxLifespan String
defaultDefaultClientScopes List<String>
defaultOptionalClientScopes List<String>
defaultSignatureAlgorithm String
directGrantFlow String
displayName String
dockerAuthenticationFlow String
duplicateEmailsAllowed Boolean
editUsernameAllowed Boolean
emailTheme String
enabled Boolean
id String
The provider-assigned unique ID for this managed resource.
internalId String
internationalizations List<GetRealmInternationalization>
loginTheme String
loginWithEmailAllowed Boolean
oauth2DeviceCodeLifespan String
oauth2DevicePollingInterval Integer
offlineSessionIdleTimeout String
offlineSessionMaxLifespan String
offlineSessionMaxLifespanEnabled Boolean
otpPolicy GetRealmOtpPolicy
passwordPolicy String
realm String
refreshTokenMaxReuse Integer
registrationAllowed Boolean
registrationEmailAsUsername Boolean
registrationFlow String
rememberMe Boolean
resetCredentialsFlow String
resetPasswordAllowed Boolean
revokeRefreshToken Boolean
securityDefenses List<GetRealmSecurityDefense>
smtpServers List<GetRealmSmtpServer>
sslRequired String
ssoSessionIdleTimeout String
ssoSessionIdleTimeoutRememberMe String
ssoSessionMaxLifespan String
ssoSessionMaxLifespanRememberMe String
userManagedAccess Boolean
verifyEmail Boolean
webAuthnPasswordlessPolicy GetRealmWebAuthnPasswordlessPolicy
webAuthnPolicy GetRealmWebAuthnPolicy
displayNameHtml String
accessCodeLifespan string
accessCodeLifespanLogin string
accessCodeLifespanUserAction string
accessTokenLifespan string
accessTokenLifespanForImplicitFlow string
accountTheme string
actionTokenGeneratedByAdminLifespan string
actionTokenGeneratedByUserLifespan string
adminTheme string
attributes {[key: string]: string}
browserFlow string
clientAuthenticationFlow string
clientSessionIdleTimeout string
clientSessionMaxLifespan string
defaultDefaultClientScopes string[]
defaultOptionalClientScopes string[]
defaultSignatureAlgorithm string
directGrantFlow string
displayName string
dockerAuthenticationFlow string
duplicateEmailsAllowed boolean
editUsernameAllowed boolean
emailTheme string
enabled boolean
id string
The provider-assigned unique ID for this managed resource.
internalId string
internationalizations GetRealmInternationalization[]
loginTheme string
loginWithEmailAllowed boolean
oauth2DeviceCodeLifespan string
oauth2DevicePollingInterval number
offlineSessionIdleTimeout string
offlineSessionMaxLifespan string
offlineSessionMaxLifespanEnabled boolean
otpPolicy GetRealmOtpPolicy
passwordPolicy string
realm string
refreshTokenMaxReuse number
registrationAllowed boolean
registrationEmailAsUsername boolean
registrationFlow string
rememberMe boolean
resetCredentialsFlow string
resetPasswordAllowed boolean
revokeRefreshToken boolean
securityDefenses GetRealmSecurityDefense[]
smtpServers GetRealmSmtpServer[]
sslRequired string
ssoSessionIdleTimeout string
ssoSessionIdleTimeoutRememberMe string
ssoSessionMaxLifespan string
ssoSessionMaxLifespanRememberMe string
userManagedAccess boolean
verifyEmail boolean
webAuthnPasswordlessPolicy GetRealmWebAuthnPasswordlessPolicy
webAuthnPolicy GetRealmWebAuthnPolicy
displayNameHtml string
access_code_lifespan str
access_code_lifespan_login str
access_code_lifespan_user_action str
access_token_lifespan str
access_token_lifespan_for_implicit_flow str
account_theme str
action_token_generated_by_admin_lifespan str
action_token_generated_by_user_lifespan str
admin_theme str
attributes Mapping[str, str]
browser_flow str
client_authentication_flow str
client_session_idle_timeout str
client_session_max_lifespan str
default_default_client_scopes Sequence[str]
default_optional_client_scopes Sequence[str]
default_signature_algorithm str
direct_grant_flow str
display_name str
docker_authentication_flow str
duplicate_emails_allowed bool
edit_username_allowed bool
email_theme str
enabled bool
id str
The provider-assigned unique ID for this managed resource.
internal_id str
internationalizations Sequence[GetRealmInternationalization]
login_theme str
login_with_email_allowed bool
oauth2_device_code_lifespan str
oauth2_device_polling_interval int
offline_session_idle_timeout str
offline_session_max_lifespan str
offline_session_max_lifespan_enabled bool
otp_policy GetRealmOtpPolicy
password_policy str
realm str
refresh_token_max_reuse int
registration_allowed bool
registration_email_as_username bool
registration_flow str
remember_me bool
reset_credentials_flow str
reset_password_allowed bool
revoke_refresh_token bool
security_defenses Sequence[GetRealmSecurityDefense]
smtp_servers Sequence[GetRealmSmtpServer]
ssl_required str
sso_session_idle_timeout str
sso_session_idle_timeout_remember_me str
sso_session_max_lifespan str
sso_session_max_lifespan_remember_me str
user_managed_access bool
verify_email bool
web_authn_passwordless_policy GetRealmWebAuthnPasswordlessPolicy
web_authn_policy GetRealmWebAuthnPolicy
display_name_html str
accessCodeLifespan String
accessCodeLifespanLogin String
accessCodeLifespanUserAction String
accessTokenLifespan String
accessTokenLifespanForImplicitFlow String
accountTheme String
actionTokenGeneratedByAdminLifespan String
actionTokenGeneratedByUserLifespan String
adminTheme String
attributes Map<String>
browserFlow String
clientAuthenticationFlow String
clientSessionIdleTimeout String
clientSessionMaxLifespan String
defaultDefaultClientScopes List<String>
defaultOptionalClientScopes List<String>
defaultSignatureAlgorithm String
directGrantFlow String
displayName String
dockerAuthenticationFlow String
duplicateEmailsAllowed Boolean
editUsernameAllowed Boolean
emailTheme String
enabled Boolean
id String
The provider-assigned unique ID for this managed resource.
internalId String
internationalizations List<Property Map>
loginTheme String
loginWithEmailAllowed Boolean
oauth2DeviceCodeLifespan String
oauth2DevicePollingInterval Number
offlineSessionIdleTimeout String
offlineSessionMaxLifespan String
offlineSessionMaxLifespanEnabled Boolean
otpPolicy Property Map
passwordPolicy String
realm String
refreshTokenMaxReuse Number
registrationAllowed Boolean
registrationEmailAsUsername Boolean
registrationFlow String
rememberMe Boolean
resetCredentialsFlow String
resetPasswordAllowed Boolean
revokeRefreshToken Boolean
securityDefenses List<Property Map>
smtpServers List<Property Map>
sslRequired String
ssoSessionIdleTimeout String
ssoSessionIdleTimeoutRememberMe String
ssoSessionMaxLifespan String
ssoSessionMaxLifespanRememberMe String
userManagedAccess Boolean
verifyEmail Boolean
webAuthnPasswordlessPolicy Property Map
webAuthnPolicy Property Map
displayNameHtml String

Supporting Types

GetRealmInternationalization

DefaultLocale This property is required. string
SupportedLocales This property is required. List<string>
DefaultLocale This property is required. string
SupportedLocales This property is required. []string
defaultLocale This property is required. String
supportedLocales This property is required. List<String>
defaultLocale This property is required. string
supportedLocales This property is required. string[]
default_locale This property is required. str
supported_locales This property is required. Sequence[str]
defaultLocale This property is required. String
supportedLocales This property is required. List<String>

GetRealmOtpPolicy

Algorithm This property is required. string
Digits This property is required. int
InitialCounter This property is required. int
LookAheadWindow This property is required. int
Period This property is required. int
Type This property is required. string
Algorithm This property is required. string
Digits This property is required. int
InitialCounter This property is required. int
LookAheadWindow This property is required. int
Period This property is required. int
Type This property is required. string
algorithm This property is required. String
digits This property is required. Integer
initialCounter This property is required. Integer
lookAheadWindow This property is required. Integer
period This property is required. Integer
type This property is required. String
algorithm This property is required. string
digits This property is required. number
initialCounter This property is required. number
lookAheadWindow This property is required. number
period This property is required. number
type This property is required. string
algorithm This property is required. str
digits This property is required. int
initial_counter This property is required. int
look_ahead_window This property is required. int
period This property is required. int
type This property is required. str
algorithm This property is required. String
digits This property is required. Number
initialCounter This property is required. Number
lookAheadWindow This property is required. Number
period This property is required. Number
type This property is required. String

GetRealmSecurityDefense

bruteForceDetections This property is required. List<Property Map>
headers This property is required. List<Property Map>

GetRealmSecurityDefenseBruteForceDetection

FailureResetTimeSeconds This property is required. int
MaxFailureWaitSeconds This property is required. int
MaxLoginFailures This property is required. int
MinimumQuickLoginWaitSeconds This property is required. int
PermanentLockout This property is required. bool
QuickLoginCheckMilliSeconds This property is required. int
WaitIncrementSeconds This property is required. int
FailureResetTimeSeconds This property is required. int
MaxFailureWaitSeconds This property is required. int
MaxLoginFailures This property is required. int
MinimumQuickLoginWaitSeconds This property is required. int
PermanentLockout This property is required. bool
QuickLoginCheckMilliSeconds This property is required. int
WaitIncrementSeconds This property is required. int
failureResetTimeSeconds This property is required. Integer
maxFailureWaitSeconds This property is required. Integer
maxLoginFailures This property is required. Integer
minimumQuickLoginWaitSeconds This property is required. Integer
permanentLockout This property is required. Boolean
quickLoginCheckMilliSeconds This property is required. Integer
waitIncrementSeconds This property is required. Integer
failureResetTimeSeconds This property is required. number
maxFailureWaitSeconds This property is required. number
maxLoginFailures This property is required. number
minimumQuickLoginWaitSeconds This property is required. number
permanentLockout This property is required. boolean
quickLoginCheckMilliSeconds This property is required. number
waitIncrementSeconds This property is required. number
failure_reset_time_seconds This property is required. int
max_failure_wait_seconds This property is required. int
max_login_failures This property is required. int
minimum_quick_login_wait_seconds This property is required. int
permanent_lockout This property is required. bool
quick_login_check_milli_seconds This property is required. int
wait_increment_seconds This property is required. int
failureResetTimeSeconds This property is required. Number
maxFailureWaitSeconds This property is required. Number
maxLoginFailures This property is required. Number
minimumQuickLoginWaitSeconds This property is required. Number
permanentLockout This property is required. Boolean
quickLoginCheckMilliSeconds This property is required. Number
waitIncrementSeconds This property is required. Number

GetRealmSecurityDefenseHeader

ContentSecurityPolicy This property is required. string
ContentSecurityPolicyReportOnly This property is required. string
ReferrerPolicy This property is required. string
StrictTransportSecurity This property is required. string
XContentTypeOptions This property is required. string
XFrameOptions This property is required. string
XRobotsTag This property is required. string
XXssProtection This property is required. string
ContentSecurityPolicy This property is required. string
ContentSecurityPolicyReportOnly This property is required. string
ReferrerPolicy This property is required. string
StrictTransportSecurity This property is required. string
XContentTypeOptions This property is required. string
XFrameOptions This property is required. string
XRobotsTag This property is required. string
XXssProtection This property is required. string
contentSecurityPolicy This property is required. String
contentSecurityPolicyReportOnly This property is required. String
referrerPolicy This property is required. String
strictTransportSecurity This property is required. String
xContentTypeOptions This property is required. String
xFrameOptions This property is required. String
xRobotsTag This property is required. String
xXssProtection This property is required. String
contentSecurityPolicy This property is required. string
contentSecurityPolicyReportOnly This property is required. string
referrerPolicy This property is required. string
strictTransportSecurity This property is required. string
xContentTypeOptions This property is required. string
xFrameOptions This property is required. string
xRobotsTag This property is required. string
xXssProtection This property is required. string
content_security_policy This property is required. str
content_security_policy_report_only This property is required. str
referrer_policy This property is required. str
strict_transport_security This property is required. str
x_content_type_options This property is required. str
x_frame_options This property is required. str
x_robots_tag This property is required. str
x_xss_protection This property is required. str
contentSecurityPolicy This property is required. String
contentSecurityPolicyReportOnly This property is required. String
referrerPolicy This property is required. String
strictTransportSecurity This property is required. String
xContentTypeOptions This property is required. String
xFrameOptions This property is required. String
xRobotsTag This property is required. String
xXssProtection This property is required. String

GetRealmSmtpServer

Auths This property is required. List<GetRealmSmtpServerAuth>
EnvelopeFrom This property is required. string
From This property is required. string
FromDisplayName This property is required. string
Host This property is required. string
Port This property is required. string
ReplyTo This property is required. string
ReplyToDisplayName This property is required. string
Ssl This property is required. bool
Starttls This property is required. bool
Auths This property is required. []GetRealmSmtpServerAuth
EnvelopeFrom This property is required. string
From This property is required. string
FromDisplayName This property is required. string
Host This property is required. string
Port This property is required. string
ReplyTo This property is required. string
ReplyToDisplayName This property is required. string
Ssl This property is required. bool
Starttls This property is required. bool
auths This property is required. List<GetRealmSmtpServerAuth>
envelopeFrom This property is required. String
from This property is required. String
fromDisplayName This property is required. String
host This property is required. String
port This property is required. String
replyTo This property is required. String
replyToDisplayName This property is required. String
ssl This property is required. Boolean
starttls This property is required. Boolean
auths This property is required. GetRealmSmtpServerAuth[]
envelopeFrom This property is required. string
from This property is required. string
fromDisplayName This property is required. string
host This property is required. string
port This property is required. string
replyTo This property is required. string
replyToDisplayName This property is required. string
ssl This property is required. boolean
starttls This property is required. boolean
auths This property is required. Sequence[GetRealmSmtpServerAuth]
envelope_from This property is required. str
from_ This property is required. str
from_display_name This property is required. str
host This property is required. str
port This property is required. str
reply_to This property is required. str
reply_to_display_name This property is required. str
ssl This property is required. bool
starttls This property is required. bool
auths This property is required. List<Property Map>
envelopeFrom This property is required. String
from This property is required. String
fromDisplayName This property is required. String
host This property is required. String
port This property is required. String
replyTo This property is required. String
replyToDisplayName This property is required. String
ssl This property is required. Boolean
starttls This property is required. Boolean

GetRealmSmtpServerAuth

Password This property is required. string
Username This property is required. string
Password This property is required. string
Username This property is required. string
password This property is required. String
username This property is required. String
password This property is required. string
username This property is required. string
password This property is required. str
username This property is required. str
password This property is required. String
username This property is required. String

GetRealmWebAuthnPasswordlessPolicy

AcceptableAaguids This property is required. List<string>
AttestationConveyancePreference This property is required. string
Either none, indirect or direct
AuthenticatorAttachment This property is required. string
Either platform or cross-platform
AvoidSameAuthenticatorRegister This property is required. bool
CreateTimeout This property is required. int
RelyingPartyEntityName This property is required. string
RelyingPartyId This property is required. string
RequireResidentKey This property is required. string
Either Yes or No
SignatureAlgorithms This property is required. List<string>
Keycloak lists ES256, ES384, ES512, RS256, ES384, ES512 at the time of writing
UserVerificationRequirement This property is required. string
Either required, preferred or discouraged
AcceptableAaguids This property is required. []string
AttestationConveyancePreference This property is required. string
Either none, indirect or direct
AuthenticatorAttachment This property is required. string
Either platform or cross-platform
AvoidSameAuthenticatorRegister This property is required. bool
CreateTimeout This property is required. int
RelyingPartyEntityName This property is required. string
RelyingPartyId This property is required. string
RequireResidentKey This property is required. string
Either Yes or No
SignatureAlgorithms This property is required. []string
Keycloak lists ES256, ES384, ES512, RS256, ES384, ES512 at the time of writing
UserVerificationRequirement This property is required. string
Either required, preferred or discouraged
acceptableAaguids This property is required. List<String>
attestationConveyancePreference This property is required. String
Either none, indirect or direct
authenticatorAttachment This property is required. String
Either platform or cross-platform
avoidSameAuthenticatorRegister This property is required. Boolean
createTimeout This property is required. Integer
relyingPartyEntityName This property is required. String
relyingPartyId This property is required. String
requireResidentKey This property is required. String
Either Yes or No
signatureAlgorithms This property is required. List<String>
Keycloak lists ES256, ES384, ES512, RS256, ES384, ES512 at the time of writing
userVerificationRequirement This property is required. String
Either required, preferred or discouraged
acceptableAaguids This property is required. string[]
attestationConveyancePreference This property is required. string
Either none, indirect or direct
authenticatorAttachment This property is required. string
Either platform or cross-platform
avoidSameAuthenticatorRegister This property is required. boolean
createTimeout This property is required. number
relyingPartyEntityName This property is required. string
relyingPartyId This property is required. string
requireResidentKey This property is required. string
Either Yes or No
signatureAlgorithms This property is required. string[]
Keycloak lists ES256, ES384, ES512, RS256, ES384, ES512 at the time of writing
userVerificationRequirement This property is required. string
Either required, preferred or discouraged
acceptable_aaguids This property is required. Sequence[str]
attestation_conveyance_preference This property is required. str
Either none, indirect or direct
authenticator_attachment This property is required. str
Either platform or cross-platform
avoid_same_authenticator_register This property is required. bool
create_timeout This property is required. int
relying_party_entity_name This property is required. str
relying_party_id This property is required. str
require_resident_key This property is required. str
Either Yes or No
signature_algorithms This property is required. Sequence[str]
Keycloak lists ES256, ES384, ES512, RS256, ES384, ES512 at the time of writing
user_verification_requirement This property is required. str
Either required, preferred or discouraged
acceptableAaguids This property is required. List<String>
attestationConveyancePreference This property is required. String
Either none, indirect or direct
authenticatorAttachment This property is required. String
Either platform or cross-platform
avoidSameAuthenticatorRegister This property is required. Boolean
createTimeout This property is required. Number
relyingPartyEntityName This property is required. String
relyingPartyId This property is required. String
requireResidentKey This property is required. String
Either Yes or No
signatureAlgorithms This property is required. List<String>
Keycloak lists ES256, ES384, ES512, RS256, ES384, ES512 at the time of writing
userVerificationRequirement This property is required. String
Either required, preferred or discouraged

GetRealmWebAuthnPolicy

AcceptableAaguids This property is required. List<string>
AttestationConveyancePreference This property is required. string
Either none, indirect or direct
AuthenticatorAttachment This property is required. string
Either platform or cross-platform
AvoidSameAuthenticatorRegister This property is required. bool
CreateTimeout This property is required. int
RelyingPartyEntityName This property is required. string
RelyingPartyId This property is required. string
RequireResidentKey This property is required. string
Either Yes or No
SignatureAlgorithms This property is required. List<string>
Keycloak lists ES256, ES384, ES512, RS256, ES384, ES512 at the time of writing
UserVerificationRequirement This property is required. string
Either required, preferred or discouraged
AcceptableAaguids This property is required. []string
AttestationConveyancePreference This property is required. string
Either none, indirect or direct
AuthenticatorAttachment This property is required. string
Either platform or cross-platform
AvoidSameAuthenticatorRegister This property is required. bool
CreateTimeout This property is required. int
RelyingPartyEntityName This property is required. string
RelyingPartyId This property is required. string
RequireResidentKey This property is required. string
Either Yes or No
SignatureAlgorithms This property is required. []string
Keycloak lists ES256, ES384, ES512, RS256, ES384, ES512 at the time of writing
UserVerificationRequirement This property is required. string
Either required, preferred or discouraged
acceptableAaguids This property is required. List<String>
attestationConveyancePreference This property is required. String
Either none, indirect or direct
authenticatorAttachment This property is required. String
Either platform or cross-platform
avoidSameAuthenticatorRegister This property is required. Boolean
createTimeout This property is required. Integer
relyingPartyEntityName This property is required. String
relyingPartyId This property is required. String
requireResidentKey This property is required. String
Either Yes or No
signatureAlgorithms This property is required. List<String>
Keycloak lists ES256, ES384, ES512, RS256, ES384, ES512 at the time of writing
userVerificationRequirement This property is required. String
Either required, preferred or discouraged
acceptableAaguids This property is required. string[]
attestationConveyancePreference This property is required. string
Either none, indirect or direct
authenticatorAttachment This property is required. string
Either platform or cross-platform
avoidSameAuthenticatorRegister This property is required. boolean
createTimeout This property is required. number
relyingPartyEntityName This property is required. string
relyingPartyId This property is required. string
requireResidentKey This property is required. string
Either Yes or No
signatureAlgorithms This property is required. string[]
Keycloak lists ES256, ES384, ES512, RS256, ES384, ES512 at the time of writing
userVerificationRequirement This property is required. string
Either required, preferred or discouraged
acceptable_aaguids This property is required. Sequence[str]
attestation_conveyance_preference This property is required. str
Either none, indirect or direct
authenticator_attachment This property is required. str
Either platform or cross-platform
avoid_same_authenticator_register This property is required. bool
create_timeout This property is required. int
relying_party_entity_name This property is required. str
relying_party_id This property is required. str
require_resident_key This property is required. str
Either Yes or No
signature_algorithms This property is required. Sequence[str]
Keycloak lists ES256, ES384, ES512, RS256, ES384, ES512 at the time of writing
user_verification_requirement This property is required. str
Either required, preferred or discouraged
acceptableAaguids This property is required. List<String>
attestationConveyancePreference This property is required. String
Either none, indirect or direct
authenticatorAttachment This property is required. String
Either platform or cross-platform
avoidSameAuthenticatorRegister This property is required. Boolean
createTimeout This property is required. Number
relyingPartyEntityName This property is required. String
relyingPartyId This property is required. String
requireResidentKey This property is required. String
Either Yes or No
signatureAlgorithms This property is required. List<String>
Keycloak lists ES256, ES384, ES512, RS256, ES384, ES512 at the time of writing
userVerificationRequirement This property is required. String
Either required, preferred or discouraged

Package Details

Repository
Keycloak pulumi/pulumi-keycloak
License
Apache-2.0
Notes
This Pulumi package is based on the keycloak Terraform Provider.
Keycloak v6.2.2 published on Wednesday, Apr 9, 2025 by Pulumi