Class UserFederationState

Inheritance

System.Object

InputArgs

ResourceArgs

UserFederationState

Inherited Members

ResourceArgs.Empty

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Keycloak.Ldap

Assembly: Pulumi.Keycloak.dll

Syntax

public sealed class UserFederationState : ResourceArgs

Constructors

UserFederationState()

Declaration

public UserFederationState()

Properties

BatchSizeForSync

The number of users to sync within a single transaction.

Declaration

public Input<int> BatchSizeForSync { get; set; }

Property Value

Type	Description
Input<System.Int32>

BindCredential

Password of LDAP admin.

Declaration

public Input<string> BindCredential { get; set; }

Property Value

Type	Description
Input<System.String>

BindDn

DN of LDAP admin, which will be used by Keycloak to access LDAP server.

Declaration

public Input<string> BindDn { get; set; }

Property Value

Type	Description
Input<System.String>

CachePolicy

Declaration

public Input<string> CachePolicy { get; set; }

Property Value

Type	Description
Input<System.String>

ChangedSyncPeriod

How frequently Keycloak should sync changed LDAP users, in seconds. Omit this property to disable periodic changed users sync.

Declaration

public Input<int> ChangedSyncPeriod { get; set; }

Property Value

Type	Description
Input<System.Int32>

ConnectionTimeout

LDAP connection timeout (duration string)

Declaration

public Input<string> ConnectionTimeout { get; set; }

Property Value

Type	Description
Input<System.String>

ConnectionUrl

Connection URL to the LDAP server.

Declaration

public Input<string> ConnectionUrl { get; set; }

Property Value

Type	Description
Input<System.String>

CustomUserSearchFilter

Additional LDAP filter for filtering searched users. Must begin with '(' and end with ')'.

Declaration

public Input<string> CustomUserSearchFilter { get; set; }

Property Value

Type	Description
Input<System.String>

EditMode

READ_ONLY and WRITABLE are self-explanatory. UNSYNCED allows user data to be imported but not synced back to LDAP.

Declaration

public Input<string> EditMode { get; set; }

Property Value

Type	Description
Input<System.String>

Enabled

When false, this provider will not be used when performing queries for users.

Declaration

public Input<bool> Enabled { get; set; }

Property Value

Type	Description
Input<System.Boolean>

FullSyncPeriod

How frequently Keycloak should sync all LDAP users, in seconds. Omit this property to disable periodic full sync.

Declaration

public Input<int> FullSyncPeriod { get; set; }

Property Value

Type	Description
Input<System.Int32>

ImportEnabled

When true, LDAP users will be imported into the Keycloak database.

Declaration

public Input<bool> ImportEnabled { get; set; }

Property Value

Type	Description
Input<System.Boolean>

Name

Display name of the provider when displayed in the console.

Declaration

public Input<string> Name { get; set; }

Property Value

Type	Description
Input<System.String>

Pagination

When true, Keycloak assumes the LDAP server supports pagination.

Declaration

public Input<bool> Pagination { get; set; }

Property Value

Type	Description
Input<System.Boolean>

Priority

Priority of this provider when looking up users. Lower values are first.

Declaration

public Input<int> Priority { get; set; }

Property Value

Type	Description
Input<System.Int32>

RdnLdapAttribute

Name of the LDAP attribute to use as the relative distinguished name.

Declaration

public Input<string> RdnLdapAttribute { get; set; }

Property Value

Type	Description
Input<System.String>

ReadTimeout

LDAP read timeout (duration string)

Declaration

public Input<string> ReadTimeout { get; set; }

Property Value

Type	Description
Input<System.String>

RealmId

The realm this provider will provide user federation for.

Declaration

public Input<string> RealmId { get; set; }

Property Value

Type	Description
Input<System.String>

SearchScope

ONE_LEVEL: only search for users in the DN specified by user_dn. SUBTREE: search entire LDAP subtree.

Declaration

public Input<string> SearchScope { get; set; }

Property Value

Type	Description
Input<System.String>

SyncRegistrations

When true, newly created users will be synced back to LDAP.

Declaration

public Input<bool> SyncRegistrations { get; set; }

Property Value

Type	Description
Input<System.Boolean>

UsernameLdapAttribute

Name of the LDAP attribute to use as the Keycloak username.

Declaration

public Input<string> UsernameLdapAttribute { get; set; }

Property Value

Type	Description
Input<System.String>

UserObjectClasses

All values of LDAP objectClass attribute for users in LDAP.

Declaration

public InputList<string> UserObjectClasses { get; set; }

Property Value

Type	Description
InputList<System.String>

UsersDn

Full DN of LDAP tree where your users are.

Declaration

public Input<string> UsersDn { get; set; }

Property Value

Type	Description
Input<System.String>

UseTruststoreSpi

Declaration

public Input<string> UseTruststoreSpi { get; set; }

Property Value

Type	Description
Input<System.String>

UuidLdapAttribute

Name of the LDAP attribute to use as a unique object identifier for objects in LDAP.

Declaration

public Input<string> UuidLdapAttribute { get; set; }

Property Value

Type	Description
Input<System.String>

ValidatePasswordPolicy

When true, Keycloak will validate passwords using the realm policy before updating it.

Declaration

public Input<bool> ValidatePasswordPolicy { get; set; }

Property Value

Type	Description
Input<System.Boolean>

Vendor

LDAP vendor. I am almost certain this field does nothing, but the UI indicates that it is required.

Declaration

public Input<string> Vendor { get; set; }

Property Value

Type	Description
Input<System.String>