GetRealm

# keycloak..Realm data source

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",
});
const group = new keycloak.Role("group", {realmId: data.keycloak_realm.id});

import pulumi
import pulumi_keycloak as keycloak

realm = keycloak.get_realm(realm="my-realm")
group = keycloak.Role("group", realm_id=data["keycloak..Realm"]["id"])

using Pulumi;
using Keycloak = Pulumi.Keycloak;

class MyStack : Stack
{
    public MyStack()
    {
        var realm = Output.Create(Keycloak.GetRealm.InvokeAsync(new Keycloak.GetRealmArgs
        {
            Realm = "my-realm",
        }));
        var @group = new Keycloak.Role("group", new Keycloak.RoleArgs
        {
            RealmId = data.Keycloak_realm.Id,
        });
    }

}

Argument Reference

The following arguments are supported:

realm - (Required) The realm name.

Attributes Reference

See the docs for the keycloak..Realm resource for details on the exported attributes.

Using GetRealm

function getRealm(args: GetRealmArgs, opts?: InvokeOptions): Promise<GetRealmResult>

function  get_realm(attributes=None, display_name_html=None, internationalizations=None, realm=None, security_defenses=None, smtp_servers=None, opts=None)

func LookupRealm(ctx *Context, args *LookupRealmArgs, opts ...InvokeOption) (*LookupRealmResult, error)

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

public static class GetRealm {
    public static Task<GetRealmResult> InvokeAsync(GetRealmArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Realm string
Attributes Dictionary<string, object>
DisplayNameHtml string
Internationalizations List<GetRealmInternationalizationArgs>
SecurityDefenses List<GetRealmSecurityDefenseArgs>
SmtpServers List<GetRealmSmtpServerArgs>

Realm string
Attributes map[string]interface{}
DisplayNameHtml string
Internationalizations []GetRealmInternationalization
SecurityDefenses []GetRealmSecurityDefense
SmtpServers []GetRealmSmtpServer

realm string
attributes {[key: string]: any}
displayNameHtml string
internationalizations GetRealmInternationalization[]
securityDefenses GetRealmSecurityDefense[]
smtpServers GetRealmSmtpServer[]

realm str
attributes Dict[str, Any]
display_name_html str
internationalizations List[GetRealmInternationalization]
security_defenses List[GetRealmSecurityDefense]
smtp_servers List[GetRealmSmtpServer]

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, object>
BrowserFlow string
ClientAuthenticationFlow 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
OfflineSessionIdleTimeout string
OfflineSessionMaxLifespan string
PasswordPolicy string
Realm string
RefreshTokenMaxReuse int
RegistrationAllowed bool
RegistrationEmailAsUsername bool
RegistrationFlow string
RememberMe bool
ResetCredentialsFlow string
ResetPasswordAllowed bool
SecurityDefenses List<GetRealmSecurityDefense>
SmtpServers List<GetRealmSmtpServer>
SslRequired string
SsoSessionIdleTimeout string
SsoSessionMaxLifespan string
UserManagedAccess bool
VerifyEmail bool
DisplayNameHtml string

AccessCodeLifespan string
AccessCodeLifespanLogin string
AccessCodeLifespanUserAction string
AccessTokenLifespan string
AccessTokenLifespanForImplicitFlow string
AccountTheme string
ActionTokenGeneratedByAdminLifespan string
ActionTokenGeneratedByUserLifespan string
AdminTheme string
Attributes map[string]interface{}
BrowserFlow string
ClientAuthenticationFlow 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
OfflineSessionIdleTimeout string
OfflineSessionMaxLifespan string
PasswordPolicy string
Realm string
RefreshTokenMaxReuse int
RegistrationAllowed bool
RegistrationEmailAsUsername bool
RegistrationFlow string
RememberMe bool
ResetCredentialsFlow string
ResetPasswordAllowed bool
SecurityDefenses []GetRealmSecurityDefense
SmtpServers []GetRealmSmtpServer
SslRequired string
SsoSessionIdleTimeout string
SsoSessionMaxLifespan string
UserManagedAccess bool
VerifyEmail bool
DisplayNameHtml string

accessCodeLifespan string
accessCodeLifespanLogin string
accessCodeLifespanUserAction string
accessTokenLifespan string
accessTokenLifespanForImplicitFlow string
accountTheme string
actionTokenGeneratedByAdminLifespan string
actionTokenGeneratedByUserLifespan string
adminTheme string
attributes {[key: string]: any}
browserFlow string
clientAuthenticationFlow 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
offlineSessionIdleTimeout string
offlineSessionMaxLifespan string
passwordPolicy string
realm string
refreshTokenMaxReuse number
registrationAllowed boolean
registrationEmailAsUsername boolean
registrationFlow string
rememberMe boolean
resetCredentialsFlow string
resetPasswordAllowed boolean
securityDefenses GetRealmSecurityDefense[]
smtpServers GetRealmSmtpServer[]
sslRequired string
ssoSessionIdleTimeout string
ssoSessionMaxLifespan string
userManagedAccess boolean
verifyEmail boolean
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 Dict[str, Any]
browser_flow str
client_authentication_flow 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 List[GetRealmInternationalization]
login_theme str
login_with_email_allowed bool
offline_session_idle_timeout str
offline_session_max_lifespan str
password_policy str
realm str
refresh_token_max_reuse float
registration_allowed bool
registration_email_as_username bool
registration_flow str
remember_me bool
reset_credentials_flow str
reset_password_allowed bool
security_defenses List[GetRealmSecurityDefense]
smtp_servers List[GetRealmSmtpServer]
ssl_required str
sso_session_idle_timeout str
sso_session_max_lifespan str
user_managed_access bool
verify_email bool
display_name_html str

Supporting Types

GetRealmInternationalization

See the input and output API doc for this type.

DefaultLocale string
SupportedLocales List<string>

DefaultLocale string
SupportedLocales []string

defaultLocale string
supportedLocales string[]

defaultLocale str
supportedLocales List[str]

GetRealmSecurityDefense

See the input and output API doc for this type.

BruteForceDetections List<GetRealmSecurityDefenseBruteForceDetectionArgs>
Headers List<GetRealmSecurityDefenseHeaderArgs>

BruteForceDetections []GetRealmSecurityDefenseBruteForceDetection
Headers []GetRealmSecurityDefenseHeader

bruteForceDetections GetRealmSecurityDefenseBruteForceDetection[]
headers GetRealmSecurityDefenseHeader[]

bruteForceDetections List[GetRealmSecurityDefenseBruteForceDetection]
headers List[GetRealmSecurityDefenseHeader]

GetRealmSecurityDefenseBruteForceDetection

See the input and output API doc for this type.

FailureResetTimeSeconds int
MaxFailureWaitSeconds int
MaxLoginFailures int
MinimumQuickLoginWaitSeconds int
PermanentLockout bool
QuickLoginCheckMilliSeconds int
WaitIncrementSeconds int

FailureResetTimeSeconds int
MaxFailureWaitSeconds int
MaxLoginFailures int
MinimumQuickLoginWaitSeconds int
PermanentLockout bool
QuickLoginCheckMilliSeconds int
WaitIncrementSeconds int

failureResetTimeSeconds number
maxFailureWaitSeconds number
maxLoginFailures number
minimumQuickLoginWaitSeconds number
permanentLockout boolean
quickLoginCheckMilliSeconds number
waitIncrementSeconds number

failureResetTimeSeconds float
maxFailureWaitSeconds float
maxLoginFailures float
minimumQuickLoginWaitSeconds float
permanentLockout bool
quickLoginCheckMilliSeconds float
waitIncrementSeconds float

GetRealmSecurityDefenseHeader

See the input and output API doc for this type.

ContentSecurityPolicy string
ContentSecurityPolicyReportOnly string
StrictTransportSecurity string
XContentTypeOptions string
XFrameOptions string
XRobotsTag string
XXssProtection string

ContentSecurityPolicy string
ContentSecurityPolicyReportOnly string
StrictTransportSecurity string
XContentTypeOptions string
XFrameOptions string
XRobotsTag string
XXssProtection string

contentSecurityPolicy string
contentSecurityPolicyReportOnly string
strictTransportSecurity string
xContentTypeOptions string
xFrameOptions string
xRobotsTag string
xXssProtection string

contentSecurityPolicy str
contentSecurityPolicyReportOnly str
strictTransportSecurity str
xContentTypeOptions str
xFrameOptions str
xRobotsTag str
xXssProtection str

GetRealmSmtpServer

See the input and output API doc for this type.

Auths List<GetRealmSmtpServerAuthArgs>
EnvelopeFrom string
From string
FromDisplayName string
Host string
Port string
ReplyTo string
ReplyToDisplayName string
Ssl bool
Starttls bool

Auths []GetRealmSmtpServerAuth
EnvelopeFrom string
From string
FromDisplayName string
Host string
Port string
ReplyTo string
ReplyToDisplayName string
Ssl bool
Starttls bool

auths GetRealmSmtpServerAuth[]
envelopeFrom string
from string
fromDisplayName string
host string
port string
replyTo string
replyToDisplayName string
ssl boolean
starttls boolean

auths List[GetRealmSmtpServerAuth]
envelopeFrom str
from str
fromDisplayName str
host str
port str
replyTo str
replyToDisplayName str
ssl bool
starttls bool

GetRealmSmtpServerAuth

See the input and output API doc for this type.

Password string
Username string

Password string
Username string

password string
username string

password str
username str

Package Details

Repository: https://github.com/pulumi/pulumi-keycloak
License: Apache-2.0
Notes: This Pulumi package is based on the keycloak Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetRealm

# keycloak..Realm data source

Example Usage

Argument Reference

Attributes Reference

Using GetRealm

GetRealm Result

Supporting Types

GetRealmInternationalization

GetRealmSecurityDefense

GetRealmSecurityDefenseBruteForceDetection

GetRealmSecurityDefenseHeader

GetRealmSmtpServer

GetRealmSmtpServerAuth

Package Details

On This Page