Package-level declarations

Types

Link copied to clipboard
class CustomMapper : KotlinCustomResource

Allows for creating and managing custom attribute mappers for Keycloak users federated via LDAP. The LDAP custom mapper is implemented and deployed into Keycloak as a custom provider. This resource allows to specify the custom id and custom implementation class of the self-implemented attribute mapper as well as additional properties via config map. The custom mapper should already be deployed into keycloak in order to be correctly configured.

Link copied to clipboard
data class CustomMapperArgs(val config: Output<Map<String, String>>? = null, val ldapUserFederationId: Output<String>? = null, val name: Output<String>? = null, val providerId: Output<String>? = null, val providerType: Output<String>? = null, val realmId: Output<String>? = null) : ConvertibleToJava<CustomMapperArgs>

Allows for creating and managing custom attribute mappers for Keycloak users federated via LDAP. The LDAP custom mapper is implemented and deployed into Keycloak as a custom provider. This resource allows to specify the custom id and custom implementation class of the self-implemented attribute mapper as well as additional properties via config map. The custom mapper should already be deployed into keycloak in order to be correctly configured.

Link copied to clipboard
Link copied to clipboard
object CustomMapperMapper : ResourceMapper<CustomMapper>
Link copied to clipboard
Link copied to clipboard
class FullNameMapper : KotlinCustomResource

Allows for creating and managing full name mappers for Keycloak users federated via LDAP. The LDAP full name mapper can map a user's full name from an LDAP attribute to the first and last name attributes of a Keycloak user.

Link copied to clipboard
data class FullNameMapperArgs(val ldapFullNameAttribute: Output<String>? = null, val ldapUserFederationId: Output<String>? = null, val name: Output<String>? = null, val readOnly: Output<Boolean>? = null, val realmId: Output<String>? = null, val writeOnly: Output<Boolean>? = null) : ConvertibleToJava<FullNameMapperArgs>

Allows for creating and managing full name mappers for Keycloak users federated via LDAP. The LDAP full name mapper can map a user's full name from an LDAP attribute to the first and last name attributes of a Keycloak user.

Link copied to clipboard
Link copied to clipboard
object FullNameMapperMapper : ResourceMapper<FullNameMapper>
Link copied to clipboard
class GroupMapper : KotlinCustomResource

Allows for creating and managing group mappers for Keycloak users federated via LDAP. The LDAP group mapper can be used to map an LDAP user's groups from some DN to Keycloak groups. This group mapper will also create the groups within Keycloak if they do not already exist.

Link copied to clipboard
data class GroupMapperArgs(val dropNonExistingGroupsDuringSync: Output<Boolean>? = null, val groupNameLdapAttribute: Output<String>? = null, val groupObjectClasses: Output<List<String>>? = null, val groupsLdapFilter: Output<String>? = null, val groupsPath: Output<String>? = null, val ignoreMissingGroups: Output<Boolean>? = null, val ldapGroupsDn: Output<String>? = null, val ldapUserFederationId: Output<String>? = null, val mappedGroupAttributes: Output<List<String>>? = null, val memberofLdapAttribute: Output<String>? = null, val membershipAttributeType: Output<String>? = null, val membershipLdapAttribute: Output<String>? = null, val membershipUserLdapAttribute: Output<String>? = null, val mode: Output<String>? = null, val name: Output<String>? = null, val preserveGroupInheritance: Output<Boolean>? = null, val realmId: Output<String>? = null, val userRolesRetrieveStrategy: Output<String>? = null) : ConvertibleToJava<GroupMapperArgs>

Allows for creating and managing group mappers for Keycloak users federated via LDAP. The LDAP group mapper can be used to map an LDAP user's groups from some DN to Keycloak groups. This group mapper will also create the groups within Keycloak if they do not already exist.

Link copied to clipboard
Link copied to clipboard
object GroupMapperMapper : ResourceMapper<GroupMapper>
Link copied to clipboard
Link copied to clipboard
class HardcodedAttributeMapper : KotlinCustomResource

Allows for creating and managing hardcoded attribute mappers for Keycloak users federated via LDAP. The LDAP hardcoded attribute mapper will set the specified value to the LDAP attribute. NOTE: This mapper only works when the sync_registrations attribute on the keycloak.ldap.UserFederation resource is set to true.

Link copied to clipboard
data class HardcodedAttributeMapperArgs(val attributeName: Output<String>? = null, val attributeValue: Output<String>? = null, val ldapUserFederationId: Output<String>? = null, val name: Output<String>? = null, val realmId: Output<String>? = null) : ConvertibleToJava<HardcodedAttributeMapperArgs>

Allows for creating and managing hardcoded attribute mappers for Keycloak users federated via LDAP. The LDAP hardcoded attribute mapper will set the specified value to the LDAP attribute. NOTE: This mapper only works when the sync_registrations attribute on the keycloak.ldap.UserFederation resource is set to true.

Link copied to clipboard
class HardcodedGroupMapper : KotlinCustomResource

Allows for creating and managing hardcoded group mappers for Keycloak users federated via LDAP. The LDAP hardcoded group mapper will grant a specified Keycloak group to each Keycloak user linked with LDAP.

Link copied to clipboard
data class HardcodedGroupMapperArgs(val group: Output<String>? = null, val ldapUserFederationId: Output<String>? = null, val name: Output<String>? = null, val realmId: Output<String>? = null) : ConvertibleToJava<HardcodedGroupMapperArgs>

Allows for creating and managing hardcoded group mappers for Keycloak users federated via LDAP. The LDAP hardcoded group mapper will grant a specified Keycloak group to each Keycloak user linked with LDAP.

Link copied to clipboard
Link copied to clipboard
class HardcodedRoleMapper : KotlinCustomResource

Allows for creating and managing hardcoded role mappers for Keycloak users federated via LDAP. The LDAP hardcoded role mapper will grant a specified Keycloak role to each Keycloak user linked with LDAP.

Link copied to clipboard
data class HardcodedRoleMapperArgs(val ldapUserFederationId: Output<String>? = null, val name: Output<String>? = null, val realmId: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<HardcodedRoleMapperArgs>

Allows for creating and managing hardcoded role mappers for Keycloak users federated via LDAP. The LDAP hardcoded role mapper will grant a specified Keycloak role to each Keycloak user linked with LDAP.

Link copied to clipboard
Link copied to clipboard
class MsadLdsUserAccountControlMapper : KotlinCustomResource

Allows for creating and managing MSAD-LDS user account control mappers for Keycloak users federated via LDAP. The MSAD-LDS (Microsoft Active Directory Lightweight Directory Service) user account control mapper is specific to LDAP user federation providers that are pulling from AD-LDS, and it can propagate AD-LDS user state to Keycloak in order to enforce settings like expired passwords or disabled accounts.

Link copied to clipboard
data class MsadLdsUserAccountControlMapperArgs(val ldapUserFederationId: Output<String>? = null, val name: Output<String>? = null, val realmId: Output<String>? = null) : ConvertibleToJava<MsadLdsUserAccountControlMapperArgs>

Allows for creating and managing MSAD-LDS user account control mappers for Keycloak users federated via LDAP. The MSAD-LDS (Microsoft Active Directory Lightweight Directory Service) user account control mapper is specific to LDAP user federation providers that are pulling from AD-LDS, and it can propagate AD-LDS user state to Keycloak in order to enforce settings like expired passwords or disabled accounts.

Link copied to clipboard
class MsadUserAccountControlMapper : KotlinCustomResource

Allows for creating and managing MSAD user account control mappers for Keycloak users federated via LDAP. The MSAD (Microsoft Active Directory) user account control mapper is specific to LDAP user federation providers that are pulling from AD, and it can propagate AD user state to Keycloak in order to enforce settings like expired passwords or disabled accounts.

Link copied to clipboard
data class MsadUserAccountControlMapperArgs(val ldapPasswordPolicyHintsEnabled: Output<Boolean>? = null, val ldapUserFederationId: Output<String>? = null, val name: Output<String>? = null, val realmId: Output<String>? = null) : ConvertibleToJava<MsadUserAccountControlMapperArgs>

Allows for creating and managing MSAD user account control mappers for Keycloak users federated via LDAP. The MSAD (Microsoft Active Directory) user account control mapper is specific to LDAP user federation providers that are pulling from AD, and it can propagate AD user state to Keycloak in order to enforce settings like expired passwords or disabled accounts.

Link copied to clipboard
class RoleMapper : KotlinCustomResource

Allows for creating and managing role mappers for Keycloak users federated via LDAP. The LDAP group mapper can be used to map an LDAP user's roles from some DN to Keycloak roles.

Link copied to clipboard
data class RoleMapperArgs(val clientId: Output<String>? = null, val ldapRolesDn: Output<String>? = null, val ldapUserFederationId: Output<String>? = null, val memberofLdapAttribute: Output<String>? = null, val membershipAttributeType: Output<String>? = null, val membershipLdapAttribute: Output<String>? = null, val membershipUserLdapAttribute: Output<String>? = null, val mode: Output<String>? = null, val name: Output<String>? = null, val realmId: Output<String>? = null, val roleNameLdapAttribute: Output<String>? = null, val roleObjectClasses: Output<List<String>>? = null, val rolesLdapFilter: Output<String>? = null, val useRealmRolesMapping: Output<Boolean>? = null, val userRolesRetrieveStrategy: Output<String>? = null) : ConvertibleToJava<RoleMapperArgs>

Allows for creating and managing role mappers for Keycloak users federated via LDAP. The LDAP group mapper can be used to map an LDAP user's roles from some DN to Keycloak roles.

Link copied to clipboard
Link copied to clipboard
object RoleMapperMapper : ResourceMapper<RoleMapper>
Link copied to clipboard
Link copied to clipboard
class UserAttributeMapper : KotlinCustomResource

Allows for creating and managing user attribute mappers for Keycloak users federated via LDAP. The LDAP user attribute mapper can be used to map a single LDAP attribute to an attribute on the Keycloak user model.

Link copied to clipboard
data class UserAttributeMapperArgs(val alwaysReadValueFromLdap: Output<Boolean>? = null, val attributeDefaultValue: Output<String>? = null, val attributeForceDefault: Output<Boolean>? = null, val isBinaryAttribute: Output<Boolean>? = null, val isMandatoryInLdap: Output<Boolean>? = null, val ldapAttribute: Output<String>? = null, val ldapUserFederationId: Output<String>? = null, val name: Output<String>? = null, val readOnly: Output<Boolean>? = null, val realmId: Output<String>? = null, val userModelAttribute: Output<String>? = null) : ConvertibleToJava<UserAttributeMapperArgs>

Allows for creating and managing user attribute mappers for Keycloak users federated via LDAP. The LDAP user attribute mapper can be used to map a single LDAP attribute to an attribute on the Keycloak user model.

Link copied to clipboard
Link copied to clipboard
class UserFederation : KotlinCustomResource

Allows for creating and managing LDAP user federation providers within Keycloak. Keycloak can use an LDAP user federation provider to federate users to Keycloak from a directory system such as LDAP or Active Directory. Federated users will exist within the realm and will be able to log in to clients. Federated users can have their attributes defined using mappers.

Link copied to clipboard
data class UserFederationArgs(val batchSizeForSync: Output<Int>? = null, val bindCredential: Output<String>? = null, val bindDn: Output<String>? = null, val cache: Output<UserFederationCacheArgs>? = null, val changedSyncPeriod: Output<Int>? = null, val connectionTimeout: Output<String>? = null, val connectionUrl: Output<String>? = null, val customUserSearchFilter: Output<String>? = null, val deleteDefaultMappers: Output<Boolean>? = null, val editMode: Output<String>? = null, val enabled: Output<Boolean>? = null, val fullSyncPeriod: Output<Int>? = null, val importEnabled: Output<Boolean>? = null, val kerberos: Output<UserFederationKerberosArgs>? = null, val name: Output<String>? = null, val pagination: Output<Boolean>? = null, val priority: Output<Int>? = null, val rdnLdapAttribute: Output<String>? = null, val readTimeout: Output<String>? = null, val realmId: Output<String>? = null, val searchScope: Output<String>? = null, val startTls: Output<Boolean>? = null, val syncRegistrations: Output<Boolean>? = null, val trustEmail: Output<Boolean>? = null, val usePasswordModifyExtendedOp: Output<Boolean>? = null, val useTruststoreSpi: Output<String>? = null, val userObjectClasses: Output<List<String>>? = null, val usernameLdapAttribute: Output<String>? = null, val usersDn: Output<String>? = null, val uuidLdapAttribute: Output<String>? = null, val validatePasswordPolicy: Output<Boolean>? = null, val vendor: Output<String>? = null) : ConvertibleToJava<UserFederationArgs>

Allows for creating and managing LDAP user federation providers within Keycloak. Keycloak can use an LDAP user federation provider to federate users to Keycloak from a directory system such as LDAP or Active Directory. Federated users will exist within the realm and will be able to log in to clients. Federated users can have their attributes defined using mappers.

Link copied to clipboard
Link copied to clipboard
object UserFederationMapper : ResourceMapper<UserFederation>

Functions

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
suspend fun groupMapper(name: String, block: suspend GroupMapperResourceBuilder.() -> Unit): GroupMapper
Link copied to clipboard
suspend fun roleMapper(name: String, block: suspend RoleMapperResourceBuilder.() -> Unit): RoleMapper
Link copied to clipboard