authmethodldap

package
v9.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 22, 2024 License: MPL-2.0 Imports: 7 Imported by: 0

README

boundary_auth_method_ldap

Refer to the Terraform Registry for docs: boundary_auth_method_ldap.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AuthMethodLdap_GenerateConfigForImport 

func AuthMethodLdap_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource

Generates CDKTF code for importing a AuthMethodLdap resource upon running "cdktf plan <stack-name>".

func AuthMethodLdap_IsConstruct 

func AuthMethodLdap_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func AuthMethodLdap_IsTerraformElement 

func AuthMethodLdap_IsTerraformElement(x interface{}) *bool

Experimental.

func AuthMethodLdap_IsTerraformResource 

func AuthMethodLdap_IsTerraformResource(x interface{}) *bool

Experimental.

func AuthMethodLdap_TfResourceType 

func AuthMethodLdap_TfResourceType() *string

func NewAuthMethodLdap_Override 

func NewAuthMethodLdap_Override(a AuthMethodLdap, scope constructs.Construct, id *string, config *AuthMethodLdapConfig)

Create a new {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap boundary_auth_method_ldap} Resource.

Types

type AuthMethodLdap 

type AuthMethodLdap interface {
	cdktf.TerraformResource
	AccountAttributeMaps() *[]*string
	SetAccountAttributeMaps(val *[]*string)
	AccountAttributeMapsInput() *[]*string
	AnonGroupSearch() interface{}
	SetAnonGroupSearch(val interface{})
	AnonGroupSearchInput() interface{}
	BindDn() *string
	SetBindDn(val *string)
	BindDnInput() *string
	BindPassword() *string
	SetBindPassword(val *string)
	BindPasswordHmac() *string
	SetBindPasswordHmac(val *string)
	BindPasswordHmacInput() *string
	BindPasswordInput() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	Certificates() *[]*string
	SetCertificates(val *[]*string)
	CertificatesInput() *[]*string
	ClientCertificate() *string
	SetClientCertificate(val *string)
	ClientCertificateInput() *string
	ClientCertificateKey() *string
	SetClientCertificateKey(val *string)
	ClientCertificateKeyHmac() *string
	SetClientCertificateKeyHmac(val *string)
	ClientCertificateKeyHmacInput() *string
	ClientCertificateKeyInput() *string
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	DereferenceAliases() *string
	SetDereferenceAliases(val *string)
	DereferenceAliasesInput() *string
	Description() *string
	SetDescription(val *string)
	DescriptionInput() *string
	DiscoverDn() interface{}
	SetDiscoverDn(val interface{})
	DiscoverDnInput() interface{}
	EnableGroups() interface{}
	SetEnableGroups(val interface{})
	EnableGroupsInput() interface{}
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	GroupAttr() *string
	SetGroupAttr(val *string)
	GroupAttrInput() *string
	GroupDn() *string
	SetGroupDn(val *string)
	GroupDnInput() *string
	GroupFilter() *string
	SetGroupFilter(val *string)
	GroupFilterInput() *string
	Id() *string
	InsecureTls() interface{}
	SetInsecureTls(val interface{})
	InsecureTlsInput() interface{}
	IsPrimaryForScope() interface{}
	SetIsPrimaryForScope(val interface{})
	IsPrimaryForScopeInput() interface{}
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	MaximumPageSize() *float64
	SetMaximumPageSize(val *float64)
	MaximumPageSizeInput() *float64
	Name() *string
	SetName(val *string)
	NameInput() *string
	// The tree node.
	Node() constructs.Node
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	ScopeId() *string
	SetScopeId(val *string)
	ScopeIdInput() *string
	StartTls() interface{}
	SetStartTls(val interface{})
	StartTlsInput() interface{}
	State() *string
	SetState(val *string)
	StateInput() *string
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	Type() *string
	SetType(val *string)
	TypeInput() *string
	UpnDomain() *string
	SetUpnDomain(val *string)
	UpnDomainInput() *string
	Urls() *[]*string
	SetUrls(val *[]*string)
	UrlsInput() *[]*string
	UserAttr() *string
	SetUserAttr(val *string)
	UserAttrInput() *string
	UserDn() *string
	SetUserDn(val *string)
	UserDnInput() *string
	UserFilter() *string
	SetUserFilter(val *string)
	UserFilterInput() *string
	UseTokenGroups() interface{}
	SetUseTokenGroups(val interface{})
	UseTokenGroupsInput() interface{}
	// Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
	// Experimental.
	AddMoveTarget(moveTarget *string)
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	HasResourceMove() interface{}
	// Experimental.
	ImportFrom(id *string, provider cdktf.TerraformProvider)
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// Move the resource corresponding to "id" to this resource.
	//
	// Note that the resource being moved from must be marked as moved using it's instance function.
	// Experimental.
	MoveFromId(id *string)
	// Moves this resource to the target resource given by moveTarget.
	// Experimental.
	MoveTo(moveTarget *string, index interface{})
	// Moves this resource to the resource corresponding to "id".
	// Experimental.
	MoveToId(id *string)
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetAccountAttributeMaps()
	ResetAnonGroupSearch()
	ResetBindDn()
	ResetBindPassword()
	ResetBindPasswordHmac()
	ResetCertificates()
	ResetClientCertificate()
	ResetClientCertificateKey()
	ResetClientCertificateKeyHmac()
	ResetDereferenceAliases()
	ResetDescription()
	ResetDiscoverDn()
	ResetEnableGroups()
	ResetGroupAttr()
	ResetGroupDn()
	ResetGroupFilter()
	ResetInsecureTls()
	ResetIsPrimaryForScope()
	ResetMaximumPageSize()
	ResetName()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetStartTls()
	ResetState()
	ResetType()
	ResetUpnDomain()
	ResetUrls()
	ResetUserAttr()
	ResetUserDn()
	ResetUserFilter()
	ResetUseTokenGroups()
	SynthesizeAttributes() *map[string]interface{}
	SynthesizeHclAttributes() *map[string]interface{}
	// Experimental.
	ToHclTerraform() interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

Represents a {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap boundary_auth_method_ldap}.

func NewAuthMethodLdap 

func NewAuthMethodLdap(scope constructs.Construct, id *string, config *AuthMethodLdapConfig) AuthMethodLdap

Create a new {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap boundary_auth_method_ldap} Resource.

type AuthMethodLdapConfig 

type AuthMethodLdapConfig struct {
	// Experimental.
	Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
	// Experimental.
	Count interface{} `field:"optional" json:"count" yaml:"count"`
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
	// Experimental.
	Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
	// Experimental.
	Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
	// The scope ID.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#scope_id AuthMethodLdap#scope_id}
	ScopeId *string `field:"required" json:"scopeId" yaml:"scopeId"`
	// Account attribute maps fullname and email.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#account_attribute_maps AuthMethodLdap#account_attribute_maps}
	AccountAttributeMaps *[]*string `field:"optional" json:"accountAttributeMaps" yaml:"accountAttributeMaps"`
	// Use anon bind when performing LDAP group searches (optional).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#anon_group_search AuthMethodLdap#anon_group_search}
	AnonGroupSearch interface{} `field:"optional" json:"anonGroupSearch" yaml:"anonGroupSearch"`
	// The distinguished name of entry to bind when performing user and group searches (optional).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#bind_dn AuthMethodLdap#bind_dn}
	BindDn *string `field:"optional" json:"bindDn" yaml:"bindDn"`
	// The password to use along with bind-dn performing user and group searches (optional).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#bind_password AuthMethodLdap#bind_password}
	BindPassword *string `field:"optional" json:"bindPassword" yaml:"bindPassword"`
	// The HMAC of the bind password returned by the Boundary controller, which is used for comparison after initial setting of the value.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#bind_password_hmac AuthMethodLdap#bind_password_hmac}
	BindPasswordHmac *string `field:"optional" json:"bindPasswordHmac" yaml:"bindPasswordHmac"`
	// PEM-encoded X.509 CA certificate in ASN.1 DER form that can be used as a trust anchor when connecting to an LDAP server(optional).  This may be specified multiple times.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#certificates AuthMethodLdap#certificates}
	Certificates *[]*string `field:"optional" json:"certificates" yaml:"certificates"`
	// PEM-encoded X.509 client certificate in ASN.1 DER form that can be used to authenticate against an LDAP server(optional).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#client_certificate AuthMethodLdap#client_certificate}
	ClientCertificate *string `field:"optional" json:"clientCertificate" yaml:"clientCertificate"`
	// PEM-encoded X.509 client certificate key in PKCS #8, ASN.1 DER form used with the client certificate (optional).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#client_certificate_key AuthMethodLdap#client_certificate_key}
	ClientCertificateKey *string `field:"optional" json:"clientCertificateKey" yaml:"clientCertificateKey"`
	// The HMAC of the client certificate key returned by the Boundary controller, which is used for comparison after initial setting of the value.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#client_certificate_key_hmac AuthMethodLdap#client_certificate_key_hmac}
	ClientCertificateKeyHmac *string `field:"optional" json:"clientCertificateKeyHmac" yaml:"clientCertificateKeyHmac"`
	// Control how aliases are dereferenced when performing the search. Can be one of: NeverDerefAliases, DerefInSearching, DerefFindingBaseObj, and DerefAlways (optional).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#dereference_aliases AuthMethodLdap#dereference_aliases}
	DereferenceAliases *string `field:"optional" json:"dereferenceAliases" yaml:"dereferenceAliases"`
	// The auth method description.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#description AuthMethodLdap#description}
	Description *string `field:"optional" json:"description" yaml:"description"`
	// Use anon bind to discover the bind DN of a user (optional).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#discover_dn AuthMethodLdap#discover_dn}
	DiscoverDn interface{} `field:"optional" json:"discoverDn" yaml:"discoverDn"`
	// Find the authenticated user's groups during authentication (optional).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#enable_groups AuthMethodLdap#enable_groups}
	EnableGroups interface{} `field:"optional" json:"enableGroups" yaml:"enableGroups"`
	// The attribute that enumerates a user's group membership from entries returned by a group search (optional).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#group_attr AuthMethodLdap#group_attr}
	GroupAttr *string `field:"optional" json:"groupAttr" yaml:"groupAttr"`
	// The base DN under which to perform group search.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#group_dn AuthMethodLdap#group_dn}
	GroupDn *string `field:"optional" json:"groupDn" yaml:"groupDn"`
	// A go template used to construct a LDAP group search filter (optional).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#group_filter AuthMethodLdap#group_filter}
	GroupFilter *string `field:"optional" json:"groupFilter" yaml:"groupFilter"`
	// Skip the LDAP server SSL certificate validation (optional) - insecure and use with caution.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#insecure_tls AuthMethodLdap#insecure_tls}
	InsecureTls interface{} `field:"optional" json:"insecureTls" yaml:"insecureTls"`
	// When true, makes this auth method the primary auth method for the scope in which it resides.
	//
	// The primary auth method for a scope means the the user will be automatically created when they login using an LDAP account.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#is_primary_for_scope AuthMethodLdap#is_primary_for_scope}
	IsPrimaryForScope interface{} `field:"optional" json:"isPrimaryForScope" yaml:"isPrimaryForScope"`
	// MaximumPageSize specifies a maximum search result size to use when retrieving the authenticated user's groups (optional).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#maximum_page_size AuthMethodLdap#maximum_page_size}
	MaximumPageSize *float64 `field:"optional" json:"maximumPageSize" yaml:"maximumPageSize"`
	// The auth method name. Defaults to the resource name.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#name AuthMethodLdap#name}
	Name *string `field:"optional" json:"name" yaml:"name"`
	// Issue StartTLS command after connecting (optional).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#start_tls AuthMethodLdap#start_tls}
	StartTls interface{} `field:"optional" json:"startTls" yaml:"startTls"`
	// Can be one of 'inactive', 'active-private', or 'active-public'. Defaults to active-public.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#state AuthMethodLdap#state}
	State *string `field:"optional" json:"state" yaml:"state"`
	// The type of auth method; hardcoded.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#type AuthMethodLdap#type}
	Type *string `field:"optional" json:"type" yaml:"type"`
	// The userPrincipalDomain used to construct the UPN string for the authenticating user (optional).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#upn_domain AuthMethodLdap#upn_domain}
	UpnDomain *string `field:"optional" json:"upnDomain" yaml:"upnDomain"`
	// The LDAP URLs that specify LDAP servers to connect to (required).  May be specified multiple times.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#urls AuthMethodLdap#urls}
	Urls *[]*string `field:"optional" json:"urls" yaml:"urls"`
	// The attribute on user entry matching the username passed when authenticating (optional).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#user_attr AuthMethodLdap#user_attr}
	UserAttr *string `field:"optional" json:"userAttr" yaml:"userAttr"`
	// The base DN under which to perform user search (optional).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#user_dn AuthMethodLdap#user_dn}
	UserDn *string `field:"optional" json:"userDn" yaml:"userDn"`
	// A go template used to construct a LDAP user search filter (optional).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#user_filter AuthMethodLdap#user_filter}
	UserFilter *string `field:"optional" json:"userFilter" yaml:"userFilter"`
	// Use the Active Directory tokenGroups constructed attribute of the user to find the group memberships (optional).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.2.0/docs/resources/auth_method_ldap#use_token_groups AuthMethodLdap#use_token_groups}
	UseTokenGroups interface{} `field:"optional" json:"useTokenGroups" yaml:"useTokenGroups"`
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.