Docs Packages
  1. Pulumi Registry
  2. MongoDB Atlas
  3. API Docs
  4. getLdapConfiguration
mongodbatlas logo
MongoDB Atlas v3.7.2, Mar 31 23

mongodbatlas.getLdapConfiguration

Explore with Pulumi AI

mongodbatlas.LdapConfiguration describes a LDAP Configuration.

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

Using getLdapConfiguration

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getLdapConfiguration(args: GetLdapConfigurationArgs, opts?: InvokeOptions): Promise<GetLdapConfigurationResult>
function getLdapConfigurationOutput(args: GetLdapConfigurationOutputArgs, opts?: InvokeOptions): Output<GetLdapConfigurationResult>
def get_ldap_configuration(project_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetLdapConfigurationResult
def get_ldap_configuration_output(project_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetLdapConfigurationResult]
func LookupLdapConfiguration(ctx *Context, args *LookupLdapConfigurationArgs, opts ...InvokeOption) (*LookupLdapConfigurationResult, error)
func LookupLdapConfigurationOutput(ctx *Context, args *LookupLdapConfigurationOutputArgs, opts ...InvokeOption) LookupLdapConfigurationResultOutput

> Note: This function is named LookupLdapConfiguration in the Go SDK.

public static class GetLdapConfiguration 
{
    public static Task<GetLdapConfigurationResult> InvokeAsync(GetLdapConfigurationArgs args, InvokeOptions? opts = null)
    public static Output<GetLdapConfigurationResult> Invoke(GetLdapConfigurationInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetLdapConfigurationResult> getLdapConfiguration(GetLdapConfigurationArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: mongodbatlas:index/getLdapConfiguration:getLdapConfiguration
  arguments:
    # arguments dictionary

The following arguments are supported:

ProjectId string

Identifier for the Atlas project associated with the LDAP over TLS/SSL configuration.

ProjectId string

Identifier for the Atlas project associated with the LDAP over TLS/SSL configuration.

projectId String

Identifier for the Atlas project associated with the LDAP over TLS/SSL configuration.

projectId string

Identifier for the Atlas project associated with the LDAP over TLS/SSL configuration.

project_id str

Identifier for the Atlas project associated with the LDAP over TLS/SSL configuration.

projectId String

Identifier for the Atlas project associated with the LDAP over TLS/SSL configuration.

getLdapConfiguration Result

The following output properties are available:

AuthenticationEnabled bool

Specifies whether user authentication with LDAP is enabled.

AuthorizationEnabled bool

Specifies whether user authorization with LDAP is enabled.

AuthzQueryTemplate string

An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs.

BindPassword string

The password used to authenticate the bind_username.

BindUsername string

The user DN that Atlas uses to connect to the LDAP server.

CaCertificate string

CA certificate used to verify the identify of the LDAP server.

Hostname string

(Required) The hostname or IP address of the LDAP server.

Id string

The provider-assigned unique ID for this managed resource.

Port int

The port to which the LDAP server listens for client connections.

ProjectId string
UserToDnMappings List<GetLdapConfigurationUserToDnMapping>

Maps an LDAP username for authentication to an LDAP Distinguished Name (DN).

  • user_to_dn_mapping.0.match - A regular expression to match against a provided LDAP username.
  • user_to_dn_mapping.0.substitution - An LDAP Distinguished Name (DN) formatting template that converts the LDAP name matched by the match regular expression into an LDAP Distinguished Name.
  • user_to_dn_mapping.0.ldap_query - An LDAP query formatting template that inserts the LDAP name matched by the match regular expression into an LDAP query URI as specified by RFC 4515 and RFC 4516.
AuthenticationEnabled bool

Specifies whether user authentication with LDAP is enabled.

AuthorizationEnabled bool

Specifies whether user authorization with LDAP is enabled.

AuthzQueryTemplate string

An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs.

BindPassword string

The password used to authenticate the bind_username.

BindUsername string

The user DN that Atlas uses to connect to the LDAP server.

CaCertificate string

CA certificate used to verify the identify of the LDAP server.

Hostname string

(Required) The hostname or IP address of the LDAP server.

Id string

The provider-assigned unique ID for this managed resource.

Port int

The port to which the LDAP server listens for client connections.

ProjectId string
UserToDnMappings []GetLdapConfigurationUserToDnMapping

Maps an LDAP username for authentication to an LDAP Distinguished Name (DN).

  • user_to_dn_mapping.0.match - A regular expression to match against a provided LDAP username.
  • user_to_dn_mapping.0.substitution - An LDAP Distinguished Name (DN) formatting template that converts the LDAP name matched by the match regular expression into an LDAP Distinguished Name.
  • user_to_dn_mapping.0.ldap_query - An LDAP query formatting template that inserts the LDAP name matched by the match regular expression into an LDAP query URI as specified by RFC 4515 and RFC 4516.
authenticationEnabled Boolean

Specifies whether user authentication with LDAP is enabled.

authorizationEnabled Boolean

Specifies whether user authorization with LDAP is enabled.

authzQueryTemplate String

An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs.

bindPassword String

The password used to authenticate the bind_username.

bindUsername String

The user DN that Atlas uses to connect to the LDAP server.

caCertificate String

CA certificate used to verify the identify of the LDAP server.

hostname String

(Required) The hostname or IP address of the LDAP server.

id String

The provider-assigned unique ID for this managed resource.

port Integer

The port to which the LDAP server listens for client connections.

projectId String
userToDnMappings List<GetLdapConfigurationUserToDnMapping>

Maps an LDAP username for authentication to an LDAP Distinguished Name (DN).

  • user_to_dn_mapping.0.match - A regular expression to match against a provided LDAP username.
  • user_to_dn_mapping.0.substitution - An LDAP Distinguished Name (DN) formatting template that converts the LDAP name matched by the match regular expression into an LDAP Distinguished Name.
  • user_to_dn_mapping.0.ldap_query - An LDAP query formatting template that inserts the LDAP name matched by the match regular expression into an LDAP query URI as specified by RFC 4515 and RFC 4516.
authenticationEnabled boolean

Specifies whether user authentication with LDAP is enabled.

authorizationEnabled boolean

Specifies whether user authorization with LDAP is enabled.

authzQueryTemplate string

An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs.

bindPassword string

The password used to authenticate the bind_username.

bindUsername string

The user DN that Atlas uses to connect to the LDAP server.

caCertificate string

CA certificate used to verify the identify of the LDAP server.

hostname string

(Required) The hostname or IP address of the LDAP server.

id string

The provider-assigned unique ID for this managed resource.

port number

The port to which the LDAP server listens for client connections.

projectId string
userToDnMappings GetLdapConfigurationUserToDnMapping[]

Maps an LDAP username for authentication to an LDAP Distinguished Name (DN).

  • user_to_dn_mapping.0.match - A regular expression to match against a provided LDAP username.
  • user_to_dn_mapping.0.substitution - An LDAP Distinguished Name (DN) formatting template that converts the LDAP name matched by the match regular expression into an LDAP Distinguished Name.
  • user_to_dn_mapping.0.ldap_query - An LDAP query formatting template that inserts the LDAP name matched by the match regular expression into an LDAP query URI as specified by RFC 4515 and RFC 4516.
authentication_enabled bool

Specifies whether user authentication with LDAP is enabled.

authorization_enabled bool

Specifies whether user authorization with LDAP is enabled.

authz_query_template str

An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs.

bind_password str

The password used to authenticate the bind_username.

bind_username str

The user DN that Atlas uses to connect to the LDAP server.

ca_certificate str

CA certificate used to verify the identify of the LDAP server.

hostname str

(Required) The hostname or IP address of the LDAP server.

id str

The provider-assigned unique ID for this managed resource.

port int

The port to which the LDAP server listens for client connections.

project_id str
user_to_dn_mappings Sequence[GetLdapConfigurationUserToDnMapping]

Maps an LDAP username for authentication to an LDAP Distinguished Name (DN).

  • user_to_dn_mapping.0.match - A regular expression to match against a provided LDAP username.
  • user_to_dn_mapping.0.substitution - An LDAP Distinguished Name (DN) formatting template that converts the LDAP name matched by the match regular expression into an LDAP Distinguished Name.
  • user_to_dn_mapping.0.ldap_query - An LDAP query formatting template that inserts the LDAP name matched by the match regular expression into an LDAP query URI as specified by RFC 4515 and RFC 4516.
authenticationEnabled Boolean

Specifies whether user authentication with LDAP is enabled.

authorizationEnabled Boolean

Specifies whether user authorization with LDAP is enabled.

authzQueryTemplate String

An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs.

bindPassword String

The password used to authenticate the bind_username.

bindUsername String

The user DN that Atlas uses to connect to the LDAP server.

caCertificate String

CA certificate used to verify the identify of the LDAP server.

hostname String

(Required) The hostname or IP address of the LDAP server.

id String

The provider-assigned unique ID for this managed resource.

port Number

The port to which the LDAP server listens for client connections.

projectId String
userToDnMappings List<Property Map>

Maps an LDAP username for authentication to an LDAP Distinguished Name (DN).

  • user_to_dn_mapping.0.match - A regular expression to match against a provided LDAP username.
  • user_to_dn_mapping.0.substitution - An LDAP Distinguished Name (DN) formatting template that converts the LDAP name matched by the match regular expression into an LDAP Distinguished Name.
  • user_to_dn_mapping.0.ldap_query - An LDAP query formatting template that inserts the LDAP name matched by the match regular expression into an LDAP query URI as specified by RFC 4515 and RFC 4516.

Supporting Types

GetLdapConfigurationUserToDnMapping

LdapQuery string
Match string
Substitution string
LdapQuery string
Match string
Substitution string
ldapQuery String
match String
substitution String
ldapQuery string
match string
substitution string
ldapQuery String
match String
substitution String

Package Details

Repository
MongoDB Atlas pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes

This Pulumi package is based on the mongodbatlas Terraform Provider.