published on Thursday, Nov 19, 2026 by akeyless-community
published on Thursday, Nov 19, 2026 by akeyless-community
LDAP auth config for gateway
Create GatewayLdapAuthConfig Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GatewayLdapAuthConfig(name: string, args?: GatewayLdapAuthConfigArgs, opts?: CustomResourceOptions);@overload
def GatewayLdapAuthConfig(resource_name: str,
args: Optional[GatewayLdapAuthConfigArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def GatewayLdapAuthConfig(resource_name: str,
opts: Optional[ResourceOptions] = None,
access_id: Optional[str] = None,
bind_dn: Optional[str] = None,
bind_dn_password: Optional[str] = None,
gateway_ldap_auth_config_id: Optional[str] = None,
group_attr: Optional[str] = None,
group_dn: Optional[str] = None,
group_filter: Optional[str] = None,
ldap_ca_cert: Optional[str] = None,
ldap_enable: Optional[str] = None,
ldap_url: Optional[str] = None,
retry: Optional[GatewayLdapAuthConfigRetryArgs] = None,
signing_key_data: Optional[str] = None,
user_attribute: Optional[str] = None,
user_dn: Optional[str] = None)func NewGatewayLdapAuthConfig(ctx *Context, name string, args *GatewayLdapAuthConfigArgs, opts ...ResourceOption) (*GatewayLdapAuthConfig, error)public GatewayLdapAuthConfig(string name, GatewayLdapAuthConfigArgs? args = null, CustomResourceOptions? opts = null)
public GatewayLdapAuthConfig(String name, GatewayLdapAuthConfigArgs args)
public GatewayLdapAuthConfig(String name, GatewayLdapAuthConfigArgs args, CustomResourceOptions options)
type: akeyless:GatewayLdapAuthConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "akeyless_gateway_ldap_auth_config" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args GatewayLdapAuthConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args GatewayLdapAuthConfigArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args GatewayLdapAuthConfigArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GatewayLdapAuthConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GatewayLdapAuthConfigArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var gatewayLdapAuthConfigResource = new Akeyless.GatewayLdapAuthConfig("gatewayLdapAuthConfigResource", new()
{
AccessId = "string",
BindDn = "string",
BindDnPassword = "string",
GatewayLdapAuthConfigId = "string",
GroupAttr = "string",
GroupDn = "string",
GroupFilter = "string",
LdapCaCert = "string",
LdapEnable = "string",
LdapUrl = "string",
Retry = new Akeyless.Inputs.GatewayLdapAuthConfigRetryArgs
{
ErrorMessageRegexes = new[]
{
"string",
},
IntervalSeconds = 0.0,
MaxIntervalSeconds = 0.0,
MaxRetries = 0.0,
RetryOnStatusCodes = new[]
{
0.0,
},
},
SigningKeyData = "string",
UserAttribute = "string",
UserDn = "string",
});
example, err := akeyless.NewGatewayLdapAuthConfig(ctx, "gatewayLdapAuthConfigResource", &akeyless.GatewayLdapAuthConfigArgs{
AccessId: pulumi.String("string"),
BindDn: pulumi.String("string"),
BindDnPassword: pulumi.String("string"),
GatewayLdapAuthConfigId: pulumi.String("string"),
GroupAttr: pulumi.String("string"),
GroupDn: pulumi.String("string"),
GroupFilter: pulumi.String("string"),
LdapCaCert: pulumi.String("string"),
LdapEnable: pulumi.String("string"),
LdapUrl: pulumi.String("string"),
Retry: &akeyless.GatewayLdapAuthConfigRetryArgs{
ErrorMessageRegexes: pulumi.StringArray{
pulumi.String("string"),
},
IntervalSeconds: pulumi.Float64(0),
MaxIntervalSeconds: pulumi.Float64(0),
MaxRetries: pulumi.Float64(0),
RetryOnStatusCodes: pulumi.Float64Array{
pulumi.Float64(0),
},
},
SigningKeyData: pulumi.String("string"),
UserAttribute: pulumi.String("string"),
UserDn: pulumi.String("string"),
})
resource "akeyless_gateway_ldap_auth_config" "gatewayLdapAuthConfigResource" {
lifecycle {
create_before_destroy = true
}
access_id = "string"
bind_dn = "string"
bind_dn_password = "string"
gateway_ldap_auth_config_id = "string"
group_attr = "string"
group_dn = "string"
group_filter = "string"
ldap_ca_cert = "string"
ldap_enable = "string"
ldap_url = "string"
retry = {
error_message_regexes = ["string"]
interval_seconds = 0
max_interval_seconds = 0
max_retries = 0
retry_on_status_codes = [0]
}
signing_key_data = "string"
user_attribute = "string"
user_dn = "string"
}
var gatewayLdapAuthConfigResource = new GatewayLdapAuthConfig("gatewayLdapAuthConfigResource", GatewayLdapAuthConfigArgs.builder()
.accessId("string")
.bindDn("string")
.bindDnPassword("string")
.gatewayLdapAuthConfigId("string")
.groupAttr("string")
.groupDn("string")
.groupFilter("string")
.ldapCaCert("string")
.ldapEnable("string")
.ldapUrl("string")
.retry(GatewayLdapAuthConfigRetryArgs.builder()
.errorMessageRegexes("string")
.intervalSeconds(0.0)
.maxIntervalSeconds(0.0)
.maxRetries(0.0)
.retryOnStatusCodes(0.0)
.build())
.signingKeyData("string")
.userAttribute("string")
.userDn("string")
.build());
gateway_ldap_auth_config_resource = akeyless.GatewayLdapAuthConfig("gatewayLdapAuthConfigResource",
access_id="string",
bind_dn="string",
bind_dn_password="string",
gateway_ldap_auth_config_id="string",
group_attr="string",
group_dn="string",
group_filter="string",
ldap_ca_cert="string",
ldap_enable="string",
ldap_url="string",
retry={
"error_message_regexes": ["string"],
"interval_seconds": float(0),
"max_interval_seconds": float(0),
"max_retries": float(0),
"retry_on_status_codes": [float(0)],
},
signing_key_data="string",
user_attribute="string",
user_dn="string")
const gatewayLdapAuthConfigResource = new akeyless.GatewayLdapAuthConfig("gatewayLdapAuthConfigResource", {
accessId: "string",
bindDn: "string",
bindDnPassword: "string",
gatewayLdapAuthConfigId: "string",
groupAttr: "string",
groupDn: "string",
groupFilter: "string",
ldapCaCert: "string",
ldapEnable: "string",
ldapUrl: "string",
retry: {
errorMessageRegexes: ["string"],
intervalSeconds: 0,
maxIntervalSeconds: 0,
maxRetries: 0,
retryOnStatusCodes: [0],
},
signingKeyData: "string",
userAttribute: "string",
userDn: "string",
});
type: akeyless:GatewayLdapAuthConfig
properties:
accessId: string
bindDn: string
bindDnPassword: string
gatewayLdapAuthConfigId: string
groupAttr: string
groupDn: string
groupFilter: string
ldapCaCert: string
ldapEnable: string
ldapUrl: string
retry:
errorMessageRegexes:
- string
intervalSeconds: 0
maxIntervalSeconds: 0
maxRetries: 0
retryOnStatusCodes:
- 0
signingKeyData: string
userAttribute: string
userDn: string
GatewayLdapAuthConfig Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The GatewayLdapAuthConfig resource accepts the following input properties:
- Access
Id string - The access ID of the auth method associated with the LDAP config
- Bind
Dn string - Bind DN
- Bind
Dn stringPassword - Bind DN password
- Gateway
Ldap stringAuth Config Id - The ID of this resource.
- Group
Attr string - LDAP attribute to follow on objects returned by ldapgroupfilter in order to enumerate user group membership
- Group
Dn string - Base DN to perform group membership search
- Group
Filter string - Go template used when constructing the group membership query. The template can access the following context variables: [UserDN, Username]
- Ldap
Ca stringCert - LDAP CA Certificate (base64 encoded)
- Ldap
Enable string - Enable LDAP auth [true/false]
- Ldap
Url string - LDAP server URL
- Retry
Gateway
Ldap Auth Config Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- Signing
Key stringData - The private key (base64 encoded), associated with the public key defined in the Ldap auth
- User
Attribute string - LDAP user attribute
- User
Dn string - LDAP user DN
- Access
Id string - The access ID of the auth method associated with the LDAP config
- Bind
Dn string - Bind DN
- Bind
Dn stringPassword - Bind DN password
- Gateway
Ldap stringAuth Config Id - The ID of this resource.
- Group
Attr string - LDAP attribute to follow on objects returned by ldapgroupfilter in order to enumerate user group membership
- Group
Dn string - Base DN to perform group membership search
- Group
Filter string - Go template used when constructing the group membership query. The template can access the following context variables: [UserDN, Username]
- Ldap
Ca stringCert - LDAP CA Certificate (base64 encoded)
- Ldap
Enable string - Enable LDAP auth [true/false]
- Ldap
Url string - LDAP server URL
- Retry
Gateway
Ldap Auth Config Retry Args - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- Signing
Key stringData - The private key (base64 encoded), associated with the public key defined in the Ldap auth
- User
Attribute string - LDAP user attribute
- User
Dn string - LDAP user DN
- access_
id string - The access ID of the auth method associated with the LDAP config
- bind_
dn string - Bind DN
- bind_
dn_ stringpassword - Bind DN password
- gateway_
ldap_ stringauth_ config_ id - The ID of this resource.
- group_
attr string - LDAP attribute to follow on objects returned by ldapgroupfilter in order to enumerate user group membership
- group_
dn string - Base DN to perform group membership search
- group_
filter string - Go template used when constructing the group membership query. The template can access the following context variables: [UserDN, Username]
- ldap_
ca_ stringcert - LDAP CA Certificate (base64 encoded)
- ldap_
enable string - Enable LDAP auth [true/false]
- ldap_
url string - LDAP server URL
- retry object
- Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- signing_
key_ stringdata - The private key (base64 encoded), associated with the public key defined in the Ldap auth
- user_
attribute string - LDAP user attribute
- user_
dn string - LDAP user DN
- access
Id String - The access ID of the auth method associated with the LDAP config
- bind
Dn String - Bind DN
- bind
Dn StringPassword - Bind DN password
- gateway
Ldap StringAuth Config Id - The ID of this resource.
- group
Attr String - LDAP attribute to follow on objects returned by ldapgroupfilter in order to enumerate user group membership
- group
Dn String - Base DN to perform group membership search
- group
Filter String - Go template used when constructing the group membership query. The template can access the following context variables: [UserDN, Username]
- ldap
Ca StringCert - LDAP CA Certificate (base64 encoded)
- ldap
Enable String - Enable LDAP auth [true/false]
- ldap
Url String - LDAP server URL
- retry
Gateway
Ldap Auth Config Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- signing
Key StringData - The private key (base64 encoded), associated with the public key defined in the Ldap auth
- user
Attribute String - LDAP user attribute
- user
Dn String - LDAP user DN
- access
Id string - The access ID of the auth method associated with the LDAP config
- bind
Dn string - Bind DN
- bind
Dn stringPassword - Bind DN password
- gateway
Ldap stringAuth Config Id - The ID of this resource.
- group
Attr string - LDAP attribute to follow on objects returned by ldapgroupfilter in order to enumerate user group membership
- group
Dn string - Base DN to perform group membership search
- group
Filter string - Go template used when constructing the group membership query. The template can access the following context variables: [UserDN, Username]
- ldap
Ca stringCert - LDAP CA Certificate (base64 encoded)
- ldap
Enable string - Enable LDAP auth [true/false]
- ldap
Url string - LDAP server URL
- retry
Gateway
Ldap Auth Config Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- signing
Key stringData - The private key (base64 encoded), associated with the public key defined in the Ldap auth
- user
Attribute string - LDAP user attribute
- user
Dn string - LDAP user DN
- access_
id str - The access ID of the auth method associated with the LDAP config
- bind_
dn str - Bind DN
- bind_
dn_ strpassword - Bind DN password
- gateway_
ldap_ strauth_ config_ id - The ID of this resource.
- group_
attr str - LDAP attribute to follow on objects returned by ldapgroupfilter in order to enumerate user group membership
- group_
dn str - Base DN to perform group membership search
- group_
filter str - Go template used when constructing the group membership query. The template can access the following context variables: [UserDN, Username]
- ldap_
ca_ strcert - LDAP CA Certificate (base64 encoded)
- ldap_
enable str - Enable LDAP auth [true/false]
- ldap_
url str - LDAP server URL
- retry
Gateway
Ldap Auth Config Retry Args - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- signing_
key_ strdata - The private key (base64 encoded), associated with the public key defined in the Ldap auth
- user_
attribute str - LDAP user attribute
- user_
dn str - LDAP user DN
- access
Id String - The access ID of the auth method associated with the LDAP config
- bind
Dn String - Bind DN
- bind
Dn StringPassword - Bind DN password
- gateway
Ldap StringAuth Config Id - The ID of this resource.
- group
Attr String - LDAP attribute to follow on objects returned by ldapgroupfilter in order to enumerate user group membership
- group
Dn String - Base DN to perform group membership search
- group
Filter String - Go template used when constructing the group membership query. The template can access the following context variables: [UserDN, Username]
- ldap
Ca StringCert - LDAP CA Certificate (base64 encoded)
- ldap
Enable String - Enable LDAP auth [true/false]
- ldap
Url String - LDAP server URL
- retry Property Map
- Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- signing
Key StringData - The private key (base64 encoded), associated with the public key defined in the Ldap auth
- user
Attribute String - LDAP user attribute
- user
Dn String - LDAP user DN
Outputs
All input properties are implicitly available as output properties. Additionally, the GatewayLdapAuthConfig resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing GatewayLdapAuthConfig Resource
Get an existing GatewayLdapAuthConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: GatewayLdapAuthConfigState, opts?: CustomResourceOptions): GatewayLdapAuthConfig@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
access_id: Optional[str] = None,
bind_dn: Optional[str] = None,
bind_dn_password: Optional[str] = None,
gateway_ldap_auth_config_id: Optional[str] = None,
group_attr: Optional[str] = None,
group_dn: Optional[str] = None,
group_filter: Optional[str] = None,
ldap_ca_cert: Optional[str] = None,
ldap_enable: Optional[str] = None,
ldap_url: Optional[str] = None,
retry: Optional[GatewayLdapAuthConfigRetryArgs] = None,
signing_key_data: Optional[str] = None,
user_attribute: Optional[str] = None,
user_dn: Optional[str] = None) -> GatewayLdapAuthConfigfunc GetGatewayLdapAuthConfig(ctx *Context, name string, id IDInput, state *GatewayLdapAuthConfigState, opts ...ResourceOption) (*GatewayLdapAuthConfig, error)public static GatewayLdapAuthConfig Get(string name, Input<string> id, GatewayLdapAuthConfigState? state, CustomResourceOptions? opts = null)public static GatewayLdapAuthConfig get(String name, Output<String> id, GatewayLdapAuthConfigState state, CustomResourceOptions options)resources: existingGatewayLdapAuthConfig: type: akeyless:GatewayLdapAuthConfig get: id: ${id}import {
to = akeyless_gateway_ldap_auth_config.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- state GatewayLdapAuthConfigState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state GatewayLdapAuthConfigState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- state GatewayLdapAuthConfigState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- state GatewayLdapAuthConfigState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Access
Id string - The access ID of the auth method associated with the LDAP config
- Bind
Dn string - Bind DN
- Bind
Dn stringPassword - Bind DN password
- Gateway
Ldap stringAuth Config Id - The ID of this resource.
- Group
Attr string - LDAP attribute to follow on objects returned by ldapgroupfilter in order to enumerate user group membership
- Group
Dn string - Base DN to perform group membership search
- Group
Filter string - Go template used when constructing the group membership query. The template can access the following context variables: [UserDN, Username]
- Ldap
Ca stringCert - LDAP CA Certificate (base64 encoded)
- Ldap
Enable string - Enable LDAP auth [true/false]
- Ldap
Url string - LDAP server URL
- Retry
Gateway
Ldap Auth Config Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- Signing
Key stringData - The private key (base64 encoded), associated with the public key defined in the Ldap auth
- User
Attribute string - LDAP user attribute
- User
Dn string - LDAP user DN
- Access
Id string - The access ID of the auth method associated with the LDAP config
- Bind
Dn string - Bind DN
- Bind
Dn stringPassword - Bind DN password
- Gateway
Ldap stringAuth Config Id - The ID of this resource.
- Group
Attr string - LDAP attribute to follow on objects returned by ldapgroupfilter in order to enumerate user group membership
- Group
Dn string - Base DN to perform group membership search
- Group
Filter string - Go template used when constructing the group membership query. The template can access the following context variables: [UserDN, Username]
- Ldap
Ca stringCert - LDAP CA Certificate (base64 encoded)
- Ldap
Enable string - Enable LDAP auth [true/false]
- Ldap
Url string - LDAP server URL
- Retry
Gateway
Ldap Auth Config Retry Args - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- Signing
Key stringData - The private key (base64 encoded), associated with the public key defined in the Ldap auth
- User
Attribute string - LDAP user attribute
- User
Dn string - LDAP user DN
- access_
id string - The access ID of the auth method associated with the LDAP config
- bind_
dn string - Bind DN
- bind_
dn_ stringpassword - Bind DN password
- gateway_
ldap_ stringauth_ config_ id - The ID of this resource.
- group_
attr string - LDAP attribute to follow on objects returned by ldapgroupfilter in order to enumerate user group membership
- group_
dn string - Base DN to perform group membership search
- group_
filter string - Go template used when constructing the group membership query. The template can access the following context variables: [UserDN, Username]
- ldap_
ca_ stringcert - LDAP CA Certificate (base64 encoded)
- ldap_
enable string - Enable LDAP auth [true/false]
- ldap_
url string - LDAP server URL
- retry object
- Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- signing_
key_ stringdata - The private key (base64 encoded), associated with the public key defined in the Ldap auth
- user_
attribute string - LDAP user attribute
- user_
dn string - LDAP user DN
- access
Id String - The access ID of the auth method associated with the LDAP config
- bind
Dn String - Bind DN
- bind
Dn StringPassword - Bind DN password
- gateway
Ldap StringAuth Config Id - The ID of this resource.
- group
Attr String - LDAP attribute to follow on objects returned by ldapgroupfilter in order to enumerate user group membership
- group
Dn String - Base DN to perform group membership search
- group
Filter String - Go template used when constructing the group membership query. The template can access the following context variables: [UserDN, Username]
- ldap
Ca StringCert - LDAP CA Certificate (base64 encoded)
- ldap
Enable String - Enable LDAP auth [true/false]
- ldap
Url String - LDAP server URL
- retry
Gateway
Ldap Auth Config Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- signing
Key StringData - The private key (base64 encoded), associated with the public key defined in the Ldap auth
- user
Attribute String - LDAP user attribute
- user
Dn String - LDAP user DN
- access
Id string - The access ID of the auth method associated with the LDAP config
- bind
Dn string - Bind DN
- bind
Dn stringPassword - Bind DN password
- gateway
Ldap stringAuth Config Id - The ID of this resource.
- group
Attr string - LDAP attribute to follow on objects returned by ldapgroupfilter in order to enumerate user group membership
- group
Dn string - Base DN to perform group membership search
- group
Filter string - Go template used when constructing the group membership query. The template can access the following context variables: [UserDN, Username]
- ldap
Ca stringCert - LDAP CA Certificate (base64 encoded)
- ldap
Enable string - Enable LDAP auth [true/false]
- ldap
Url string - LDAP server URL
- retry
Gateway
Ldap Auth Config Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- signing
Key stringData - The private key (base64 encoded), associated with the public key defined in the Ldap auth
- user
Attribute string - LDAP user attribute
- user
Dn string - LDAP user DN
- access_
id str - The access ID of the auth method associated with the LDAP config
- bind_
dn str - Bind DN
- bind_
dn_ strpassword - Bind DN password
- gateway_
ldap_ strauth_ config_ id - The ID of this resource.
- group_
attr str - LDAP attribute to follow on objects returned by ldapgroupfilter in order to enumerate user group membership
- group_
dn str - Base DN to perform group membership search
- group_
filter str - Go template used when constructing the group membership query. The template can access the following context variables: [UserDN, Username]
- ldap_
ca_ strcert - LDAP CA Certificate (base64 encoded)
- ldap_
enable str - Enable LDAP auth [true/false]
- ldap_
url str - LDAP server URL
- retry
Gateway
Ldap Auth Config Retry Args - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- signing_
key_ strdata - The private key (base64 encoded), associated with the public key defined in the Ldap auth
- user_
attribute str - LDAP user attribute
- user_
dn str - LDAP user DN
- access
Id String - The access ID of the auth method associated with the LDAP config
- bind
Dn String - Bind DN
- bind
Dn StringPassword - Bind DN password
- gateway
Ldap StringAuth Config Id - The ID of this resource.
- group
Attr String - LDAP attribute to follow on objects returned by ldapgroupfilter in order to enumerate user group membership
- group
Dn String - Base DN to perform group membership search
- group
Filter String - Go template used when constructing the group membership query. The template can access the following context variables: [UserDN, Username]
- ldap
Ca StringCert - LDAP CA Certificate (base64 encoded)
- ldap
Enable String - Enable LDAP auth [true/false]
- ldap
Url String - LDAP server URL
- retry Property Map
- Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- signing
Key StringData - The private key (base64 encoded), associated with the public key defined in the Ldap auth
- user
Attribute String - LDAP user attribute
- user
Dn String - LDAP user DN
Supporting Types
GatewayLdapAuthConfigRetry, GatewayLdapAuthConfigRetryArgs
- Error
Message List<string>Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- Interval
Seconds double - Wait before the first retry, in seconds. The wait doubles on each retry.
- Max
Interval doubleSeconds - Maximum wait between retries, in seconds.
- Max
Retries double - Maximum number of retries after the first attempt.
- Retry
On List<double>Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- Error
Message []stringRegexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- Interval
Seconds float64 - Wait before the first retry, in seconds. The wait doubles on each retry.
- Max
Interval float64Seconds - Maximum wait between retries, in seconds.
- Max
Retries float64 - Maximum number of retries after the first attempt.
- Retry
On []float64Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error_
message_ list(string)regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval_
seconds number - Wait before the first retry, in seconds. The wait doubles on each retry.
- max_
interval_ numberseconds - Maximum wait between retries, in seconds.
- max_
retries number - Maximum number of retries after the first attempt.
- retry_
on_ list(number)status_ codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message List<String>Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval
Seconds Double - Wait before the first retry, in seconds. The wait doubles on each retry.
- max
Interval DoubleSeconds - Maximum wait between retries, in seconds.
- max
Retries Double - Maximum number of retries after the first attempt.
- retry
On List<Double>Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message string[]Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval
Seconds number - Wait before the first retry, in seconds. The wait doubles on each retry.
- max
Interval numberSeconds - Maximum wait between retries, in seconds.
- max
Retries number - Maximum number of retries after the first attempt.
- retry
On number[]Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error_
message_ Sequence[str]regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval_
seconds float - Wait before the first retry, in seconds. The wait doubles on each retry.
- max_
interval_ floatseconds - Maximum wait between retries, in seconds.
- max_
retries float - Maximum number of retries after the first attempt.
- retry_
on_ Sequence[float]status_ codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message List<String>Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval
Seconds Number - Wait before the first retry, in seconds. The wait doubles on each retry.
- max
Interval NumberSeconds - Maximum wait between retries, in seconds.
- max
Retries Number - Maximum number of retries after the first attempt.
- retry
On List<Number>Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
Package Details
- Repository
- akeyless akeyless-community/terraform-provider-akeyless
- License
- Notes
- This Pulumi package is based on the
akeylessTerraform Provider.
published on Thursday, Nov 19, 2026 by akeyless-community