1. Registry
  2. Packages
  3. Akeyless Provider
  4. API Docs
  5. GatewayLdapAuthConfig
Viewing docs for akeyless 2.1.0
published on Thursday, Nov 19, 2026 by akeyless-community
akeyless
Viewing docs for akeyless 2.1.0
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:

    AccessId string
    The access ID of the auth method associated with the LDAP config
    BindDn string
    Bind DN
    BindDnPassword string
    Bind DN password
    GatewayLdapAuthConfigId string
    The ID of this resource.
    GroupAttr string
    LDAP attribute to follow on objects returned by ldapgroupfilter in order to enumerate user group membership
    GroupDn string
    Base DN to perform group membership search
    GroupFilter string
    Go template used when constructing the group membership query. The template can access the following context variables: [UserDN, Username]
    LdapCaCert string
    LDAP CA Certificate (base64 encoded)
    LdapEnable string
    Enable LDAP auth [true/false]
    LdapUrl string
    LDAP server URL
    Retry GatewayLdapAuthConfigRetry
    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.
    SigningKeyData string
    The private key (base64 encoded), associated with the public key defined in the Ldap auth
    UserAttribute string
    LDAP user attribute
    UserDn string
    LDAP user DN
    AccessId string
    The access ID of the auth method associated with the LDAP config
    BindDn string
    Bind DN
    BindDnPassword string
    Bind DN password
    GatewayLdapAuthConfigId string
    The ID of this resource.
    GroupAttr string
    LDAP attribute to follow on objects returned by ldapgroupfilter in order to enumerate user group membership
    GroupDn string
    Base DN to perform group membership search
    GroupFilter string
    Go template used when constructing the group membership query. The template can access the following context variables: [UserDN, Username]
    LdapCaCert string
    LDAP CA Certificate (base64 encoded)
    LdapEnable string
    Enable LDAP auth [true/false]
    LdapUrl string
    LDAP server URL
    Retry GatewayLdapAuthConfigRetryArgs
    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.
    SigningKeyData string
    The private key (base64 encoded), associated with the public key defined in the Ldap auth
    UserAttribute string
    LDAP user attribute
    UserDn 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_password string
    Bind DN password
    gateway_ldap_auth_config_id string
    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_cert string
    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_data string
    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
    accessId String
    The access ID of the auth method associated with the LDAP config
    bindDn String
    Bind DN
    bindDnPassword String
    Bind DN password
    gatewayLdapAuthConfigId String
    The ID of this resource.
    groupAttr String
    LDAP attribute to follow on objects returned by ldapgroupfilter in order to enumerate user group membership
    groupDn String
    Base DN to perform group membership search
    groupFilter String
    Go template used when constructing the group membership query. The template can access the following context variables: [UserDN, Username]
    ldapCaCert String
    LDAP CA Certificate (base64 encoded)
    ldapEnable String
    Enable LDAP auth [true/false]
    ldapUrl String
    LDAP server URL
    retry GatewayLdapAuthConfigRetry
    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.
    signingKeyData String
    The private key (base64 encoded), associated with the public key defined in the Ldap auth
    userAttribute String
    LDAP user attribute
    userDn String
    LDAP user DN
    accessId string
    The access ID of the auth method associated with the LDAP config
    bindDn string
    Bind DN
    bindDnPassword string
    Bind DN password
    gatewayLdapAuthConfigId string
    The ID of this resource.
    groupAttr string
    LDAP attribute to follow on objects returned by ldapgroupfilter in order to enumerate user group membership
    groupDn string
    Base DN to perform group membership search
    groupFilter string
    Go template used when constructing the group membership query. The template can access the following context variables: [UserDN, Username]
    ldapCaCert string
    LDAP CA Certificate (base64 encoded)
    ldapEnable string
    Enable LDAP auth [true/false]
    ldapUrl string
    LDAP server URL
    retry GatewayLdapAuthConfigRetry
    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.
    signingKeyData string
    The private key (base64 encoded), associated with the public key defined in the Ldap auth
    userAttribute string
    LDAP user attribute
    userDn 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_password str
    Bind DN password
    gateway_ldap_auth_config_id str
    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_cert str
    LDAP CA Certificate (base64 encoded)
    ldap_enable str
    Enable LDAP auth [true/false]
    ldap_url str
    LDAP server URL
    retry GatewayLdapAuthConfigRetryArgs
    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_data str
    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
    accessId String
    The access ID of the auth method associated with the LDAP config
    bindDn String
    Bind DN
    bindDnPassword String
    Bind DN password
    gatewayLdapAuthConfigId String
    The ID of this resource.
    groupAttr String
    LDAP attribute to follow on objects returned by ldapgroupfilter in order to enumerate user group membership
    groupDn String
    Base DN to perform group membership search
    groupFilter String
    Go template used when constructing the group membership query. The template can access the following context variables: [UserDN, Username]
    ldapCaCert String
    LDAP CA Certificate (base64 encoded)
    ldapEnable String
    Enable LDAP auth [true/false]
    ldapUrl 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.
    signingKeyData String
    The private key (base64 encoded), associated with the public key defined in the Ldap auth
    userAttribute String
    LDAP user attribute
    userDn 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) -> GatewayLdapAuthConfig
    func 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.
    The following state arguments are supported:
    AccessId string
    The access ID of the auth method associated with the LDAP config
    BindDn string
    Bind DN
    BindDnPassword string
    Bind DN password
    GatewayLdapAuthConfigId string
    The ID of this resource.
    GroupAttr string
    LDAP attribute to follow on objects returned by ldapgroupfilter in order to enumerate user group membership
    GroupDn string
    Base DN to perform group membership search
    GroupFilter string
    Go template used when constructing the group membership query. The template can access the following context variables: [UserDN, Username]
    LdapCaCert string
    LDAP CA Certificate (base64 encoded)
    LdapEnable string
    Enable LDAP auth [true/false]
    LdapUrl string
    LDAP server URL
    Retry GatewayLdapAuthConfigRetry
    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.
    SigningKeyData string
    The private key (base64 encoded), associated with the public key defined in the Ldap auth
    UserAttribute string
    LDAP user attribute
    UserDn string
    LDAP user DN
    AccessId string
    The access ID of the auth method associated with the LDAP config
    BindDn string
    Bind DN
    BindDnPassword string
    Bind DN password
    GatewayLdapAuthConfigId string
    The ID of this resource.
    GroupAttr string
    LDAP attribute to follow on objects returned by ldapgroupfilter in order to enumerate user group membership
    GroupDn string
    Base DN to perform group membership search
    GroupFilter string
    Go template used when constructing the group membership query. The template can access the following context variables: [UserDN, Username]
    LdapCaCert string
    LDAP CA Certificate (base64 encoded)
    LdapEnable string
    Enable LDAP auth [true/false]
    LdapUrl string
    LDAP server URL
    Retry GatewayLdapAuthConfigRetryArgs
    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.
    SigningKeyData string
    The private key (base64 encoded), associated with the public key defined in the Ldap auth
    UserAttribute string
    LDAP user attribute
    UserDn 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_password string
    Bind DN password
    gateway_ldap_auth_config_id string
    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_cert string
    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_data string
    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
    accessId String
    The access ID of the auth method associated with the LDAP config
    bindDn String
    Bind DN
    bindDnPassword String
    Bind DN password
    gatewayLdapAuthConfigId String
    The ID of this resource.
    groupAttr String
    LDAP attribute to follow on objects returned by ldapgroupfilter in order to enumerate user group membership
    groupDn String
    Base DN to perform group membership search
    groupFilter String
    Go template used when constructing the group membership query. The template can access the following context variables: [UserDN, Username]
    ldapCaCert String
    LDAP CA Certificate (base64 encoded)
    ldapEnable String
    Enable LDAP auth [true/false]
    ldapUrl String
    LDAP server URL
    retry GatewayLdapAuthConfigRetry
    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.
    signingKeyData String
    The private key (base64 encoded), associated with the public key defined in the Ldap auth
    userAttribute String
    LDAP user attribute
    userDn String
    LDAP user DN
    accessId string
    The access ID of the auth method associated with the LDAP config
    bindDn string
    Bind DN
    bindDnPassword string
    Bind DN password
    gatewayLdapAuthConfigId string
    The ID of this resource.
    groupAttr string
    LDAP attribute to follow on objects returned by ldapgroupfilter in order to enumerate user group membership
    groupDn string
    Base DN to perform group membership search
    groupFilter string
    Go template used when constructing the group membership query. The template can access the following context variables: [UserDN, Username]
    ldapCaCert string
    LDAP CA Certificate (base64 encoded)
    ldapEnable string
    Enable LDAP auth [true/false]
    ldapUrl string
    LDAP server URL
    retry GatewayLdapAuthConfigRetry
    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.
    signingKeyData string
    The private key (base64 encoded), associated with the public key defined in the Ldap auth
    userAttribute string
    LDAP user attribute
    userDn 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_password str
    Bind DN password
    gateway_ldap_auth_config_id str
    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_cert str
    LDAP CA Certificate (base64 encoded)
    ldap_enable str
    Enable LDAP auth [true/false]
    ldap_url str
    LDAP server URL
    retry GatewayLdapAuthConfigRetryArgs
    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_data str
    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
    accessId String
    The access ID of the auth method associated with the LDAP config
    bindDn String
    Bind DN
    bindDnPassword String
    Bind DN password
    gatewayLdapAuthConfigId String
    The ID of this resource.
    groupAttr String
    LDAP attribute to follow on objects returned by ldapgroupfilter in order to enumerate user group membership
    groupDn String
    Base DN to perform group membership search
    groupFilter String
    Go template used when constructing the group membership query. The template can access the following context variables: [UserDN, Username]
    ldapCaCert String
    LDAP CA Certificate (base64 encoded)
    ldapEnable String
    Enable LDAP auth [true/false]
    ldapUrl 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.
    signingKeyData String
    The private key (base64 encoded), associated with the public key defined in the Ldap auth
    userAttribute String
    LDAP user attribute
    userDn String
    LDAP user DN

    Supporting Types

    GatewayLdapAuthConfigRetry, GatewayLdapAuthConfigRetryArgs

    ErrorMessageRegexes List<string>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    IntervalSeconds double
    Wait before the first retry, in seconds. The wait doubles on each retry.
    MaxIntervalSeconds double
    Maximum wait between retries, in seconds.
    MaxRetries double
    Maximum number of retries after the first attempt.
    RetryOnStatusCodes List<double>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    ErrorMessageRegexes []string
    Regular expressions matched against the error message. If any matches, the operation is retried.
    IntervalSeconds float64
    Wait before the first retry, in seconds. The wait doubles on each retry.
    MaxIntervalSeconds float64
    Maximum wait between retries, in seconds.
    MaxRetries float64
    Maximum number of retries after the first attempt.
    RetryOnStatusCodes []float64
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    error_message_regexes list(string)
    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_seconds number
    Maximum wait between retries, in seconds.
    max_retries number
    Maximum number of retries after the first attempt.
    retry_on_status_codes list(number)
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes List<String>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds Double
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds Double
    Maximum wait between retries, in seconds.
    maxRetries Double
    Maximum number of retries after the first attempt.
    retryOnStatusCodes List<Double>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes string[]
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds number
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds number
    Maximum wait between retries, in seconds.
    maxRetries number
    Maximum number of retries after the first attempt.
    retryOnStatusCodes number[]
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    error_message_regexes Sequence[str]
    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_seconds float
    Maximum wait between retries, in seconds.
    max_retries float
    Maximum number of retries after the first attempt.
    retry_on_status_codes Sequence[float]
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes List<String>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds Number
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds Number
    Maximum wait between retries, in seconds.
    maxRetries Number
    Maximum number of retries after the first attempt.
    retryOnStatusCodes List<Number>
    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 akeyless Terraform Provider.
    akeyless
    Viewing docs for akeyless 2.1.0
    published on Thursday, Nov 19, 2026 by akeyless-community

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial