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

mongodbatlas.LdapVerify

Explore with Pulumi AI

mongodbatlas.LdapVerify provides an LDAP Verify resource. This allows a a verification of an LDAP configuration over TLS for an Atlas project. Atlas retains only the most recent request for each project.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var testProject = new Mongodbatlas.Project("testProject", new()
    {
        OrgId = "ORG ID",
    });

    var testCluster = new Mongodbatlas.Cluster("testCluster", new()
    {
        ProjectId = testProject.Id,
        DiskSizeGb = 5,
        ProviderName = "AWS",
        ProviderRegionName = "US_EAST_2",
        ProviderInstanceSizeName = "M10",
        CloudBackup = true,
    });

    //enable cloud provider snapshots
    var testLdapVerify = new Mongodbatlas.LdapVerify("testLdapVerify", new()
    {
        ProjectId = testProject.Id,
        Hostname = "HOSTNAME",
        Port = 636,
        BindUsername = "USERNAME",
        BindPassword = "PASSWORD",
    }, new CustomResourceOptions
    {
        DependsOn = new[]
        {
            testCluster,
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		testProject, err := mongodbatlas.NewProject(ctx, "testProject", &mongodbatlas.ProjectArgs{
			OrgId: pulumi.String("ORG ID"),
		})
		if err != nil {
			return err
		}
		testCluster, err := mongodbatlas.NewCluster(ctx, "testCluster", &mongodbatlas.ClusterArgs{
			ProjectId:                testProject.ID(),
			DiskSizeGb:               pulumi.Float64(5),
			ProviderName:             pulumi.String("AWS"),
			ProviderRegionName:       pulumi.String("US_EAST_2"),
			ProviderInstanceSizeName: pulumi.String("M10"),
			CloudBackup:              pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = mongodbatlas.NewLdapVerify(ctx, "testLdapVerify", &mongodbatlas.LdapVerifyArgs{
			ProjectId:    testProject.ID(),
			Hostname:     pulumi.String("HOSTNAME"),
			Port:         pulumi.Int(636),
			BindUsername: pulumi.String("USERNAME"),
			BindPassword: pulumi.String("PASSWORD"),
		}, pulumi.DependsOn([]pulumi.Resource{
			testCluster,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.Project;
import com.pulumi.mongodbatlas.ProjectArgs;
import com.pulumi.mongodbatlas.Cluster;
import com.pulumi.mongodbatlas.ClusterArgs;
import com.pulumi.mongodbatlas.LdapVerify;
import com.pulumi.mongodbatlas.LdapVerifyArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testProject = new Project("testProject", ProjectArgs.builder()        
            .orgId("ORG ID")
            .build());

        var testCluster = new Cluster("testCluster", ClusterArgs.builder()        
            .projectId(testProject.id())
            .diskSizeGb(5)
            .providerName("AWS")
            .providerRegionName("US_EAST_2")
            .providerInstanceSizeName("M10")
            .cloudBackup(true)
            .build());

        var testLdapVerify = new LdapVerify("testLdapVerify", LdapVerifyArgs.builder()        
            .projectId(testProject.id())
            .hostname("HOSTNAME")
            .port(636)
            .bindUsername("USERNAME")
            .bindPassword("PASSWORD")
            .build(), CustomResourceOptions.builder()
                .dependsOn(testCluster)
                .build());

    }
}

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test_project = mongodbatlas.Project("testProject", org_id="ORG ID")
test_cluster = mongodbatlas.Cluster("testCluster",
    project_id=test_project.id,
    disk_size_gb=5,
    provider_name="AWS",
    provider_region_name="US_EAST_2",
    provider_instance_size_name="M10",
    cloud_backup=True)
#enable cloud provider snapshots
test_ldap_verify = mongodbatlas.LdapVerify("testLdapVerify",
    project_id=test_project.id,
    hostname="HOSTNAME",
    port=636,
    bind_username="USERNAME",
    bind_password="PASSWORD",
    opts=pulumi.ResourceOptions(depends_on=[test_cluster]))

import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const testProject = new mongodbatlas.Project("testProject", {orgId: "ORG ID"});
const testCluster = new mongodbatlas.Cluster("testCluster", {
    projectId: testProject.id,
    diskSizeGb: 5,
    providerName: "AWS",
    providerRegionName: "US_EAST_2",
    providerInstanceSizeName: "M10",
    cloudBackup: true,
});
//enable cloud provider snapshots
const testLdapVerify = new mongodbatlas.LdapVerify("testLdapVerify", {
    projectId: testProject.id,
    hostname: "HOSTNAME",
    port: 636,
    bindUsername: "USERNAME",
    bindPassword: "PASSWORD",
}, {
    dependsOn: [testCluster],
});

resources:
  testProject:
    type: mongodbatlas:Project
    properties:
      orgId: ORG ID
  testCluster:
    type: mongodbatlas:Cluster
    properties:
      projectId: ${testProject.id}
      diskSizeGb: 5
      # Provider Settings "block"
      providerName: AWS
      providerRegionName: US_EAST_2
      providerInstanceSizeName: M10
      cloudBackup: true
  testLdapVerify:
    type: mongodbatlas:LdapVerify
    properties:
      projectId: ${testProject.id}
      hostname: HOSTNAME
      port: 636
      bindUsername: USERNAME
      bindPassword: PASSWORD
    options:
      dependson:
        - ${testCluster}

Create LdapVerify Resource

new LdapVerify(name: string, args: LdapVerifyArgs, opts?: CustomResourceOptions);
@overload
def LdapVerify(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               authz_query_template: Optional[str] = None,
               bind_password: Optional[str] = None,
               bind_username: Optional[str] = None,
               ca_certificate: Optional[str] = None,
               hostname: Optional[str] = None,
               port: Optional[int] = None,
               project_id: Optional[str] = None)
@overload
def LdapVerify(resource_name: str,
               args: LdapVerifyArgs,
               opts: Optional[ResourceOptions] = None)
func NewLdapVerify(ctx *Context, name string, args LdapVerifyArgs, opts ...ResourceOption) (*LdapVerify, error)
public LdapVerify(string name, LdapVerifyArgs args, CustomResourceOptions? opts = null)
public LdapVerify(String name, LdapVerifyArgs args)
public LdapVerify(String name, LdapVerifyArgs args, CustomResourceOptions options)

type: mongodbatlas:LdapVerify
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args LdapVerifyArgs
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 LdapVerifyArgs
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 LdapVerifyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args LdapVerifyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args LdapVerifyArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

LdapVerify Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The LdapVerify resource accepts the following input properties:

BindPassword string

The password used to authenticate the bind_username.

BindUsername string

The user DN that Atlas uses to connect to the LDAP server. Must be the full DN, such as CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com.

Hostname string

The hostname or IP address of the LDAP server. The server must be visible to the internet or connected to your Atlas cluster with VPC Peering.

Port int

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

ProjectId string

The unique ID for the project to configure LDAP.

AuthzQueryTemplate string

An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs. Used only for user authorization. Use the {USER} placeholder in the URL to substitute the authenticated username. The query is relative to the host specified with hostname. The formatting for the query must conform to RFC4515 and RFC 4516. If you do not provide a query template, Atlas attempts to use the default value: {USER}?memberOf?base.

CaCertificate string

CA certificate used to verify the identify of the LDAP server. Self-signed certificates are allowed.

BindPassword string

The password used to authenticate the bind_username.

BindUsername string

The user DN that Atlas uses to connect to the LDAP server. Must be the full DN, such as CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com.

Hostname string

The hostname or IP address of the LDAP server. The server must be visible to the internet or connected to your Atlas cluster with VPC Peering.

Port int

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

ProjectId string

The unique ID for the project to configure LDAP.

AuthzQueryTemplate string

An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs. Used only for user authorization. Use the {USER} placeholder in the URL to substitute the authenticated username. The query is relative to the host specified with hostname. The formatting for the query must conform to RFC4515 and RFC 4516. If you do not provide a query template, Atlas attempts to use the default value: {USER}?memberOf?base.

CaCertificate string

CA certificate used to verify the identify of the LDAP server. Self-signed certificates are allowed.

bindPassword String

The password used to authenticate the bind_username.

bindUsername String

The user DN that Atlas uses to connect to the LDAP server. Must be the full DN, such as CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com.

hostname String

The hostname or IP address of the LDAP server. The server must be visible to the internet or connected to your Atlas cluster with VPC Peering.

port Integer

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

projectId String

The unique ID for the project to configure LDAP.

authzQueryTemplate String

An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs. Used only for user authorization. Use the {USER} placeholder in the URL to substitute the authenticated username. The query is relative to the host specified with hostname. The formatting for the query must conform to RFC4515 and RFC 4516. If you do not provide a query template, Atlas attempts to use the default value: {USER}?memberOf?base.

caCertificate String

CA certificate used to verify the identify of the LDAP server. Self-signed certificates are allowed.

bindPassword string

The password used to authenticate the bind_username.

bindUsername string

The user DN that Atlas uses to connect to the LDAP server. Must be the full DN, such as CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com.

hostname string

The hostname or IP address of the LDAP server. The server must be visible to the internet or connected to your Atlas cluster with VPC Peering.

port number

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

projectId string

The unique ID for the project to configure LDAP.

authzQueryTemplate string

An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs. Used only for user authorization. Use the {USER} placeholder in the URL to substitute the authenticated username. The query is relative to the host specified with hostname. The formatting for the query must conform to RFC4515 and RFC 4516. If you do not provide a query template, Atlas attempts to use the default value: {USER}?memberOf?base.

caCertificate string

CA certificate used to verify the identify of the LDAP server. Self-signed certificates are allowed.

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. Must be the full DN, such as CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com.

hostname str

The hostname or IP address of the LDAP server. The server must be visible to the internet or connected to your Atlas cluster with VPC Peering.

port int

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

project_id str

The unique ID for the project to configure LDAP.

authz_query_template str

An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs. Used only for user authorization. Use the {USER} placeholder in the URL to substitute the authenticated username. The query is relative to the host specified with hostname. The formatting for the query must conform to RFC4515 and RFC 4516. If you do not provide a query template, Atlas attempts to use the default value: {USER}?memberOf?base.

ca_certificate str

CA certificate used to verify the identify of the LDAP server. Self-signed certificates are allowed.

bindPassword String

The password used to authenticate the bind_username.

bindUsername String

The user DN that Atlas uses to connect to the LDAP server. Must be the full DN, such as CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com.

hostname String

The hostname or IP address of the LDAP server. The server must be visible to the internet or connected to your Atlas cluster with VPC Peering.

port Number

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

projectId String

The unique ID for the project to configure LDAP.

authzQueryTemplate String

An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs. Used only for user authorization. Use the {USER} placeholder in the URL to substitute the authenticated username. The query is relative to the host specified with hostname. The formatting for the query must conform to RFC4515 and RFC 4516. If you do not provide a query template, Atlas attempts to use the default value: {USER}?memberOf?base.

caCertificate String

CA certificate used to verify the identify of the LDAP server. Self-signed certificates are allowed.

Outputs

All input properties are implicitly available as output properties. Additionally, the LdapVerify resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Links List<LdapVerifyLink>

One or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.

RequestId string

The unique identifier for the request to verify the LDAP over TLS/SSL configuration.

Status string

The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.

Validations List<LdapVerifyValidation>

Array of validation messages related to the verification of the provided LDAP over TLS/SSL configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. The following return values can be seen here: Values

Id string

The provider-assigned unique ID for this managed resource.

Links []LdapVerifyLink

One or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.

RequestId string

The unique identifier for the request to verify the LDAP over TLS/SSL configuration.

Status string

The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.

Validations []LdapVerifyValidation

Array of validation messages related to the verification of the provided LDAP over TLS/SSL configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. The following return values can be seen here: Values

id String

The provider-assigned unique ID for this managed resource.

links List<LdapVerifyLink>

One or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.

requestId String

The unique identifier for the request to verify the LDAP over TLS/SSL configuration.

status String

The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.

validations List<LdapVerifyValidation>

Array of validation messages related to the verification of the provided LDAP over TLS/SSL configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. The following return values can be seen here: Values

id string

The provider-assigned unique ID for this managed resource.

links LdapVerifyLink[]

One or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.

requestId string

The unique identifier for the request to verify the LDAP over TLS/SSL configuration.

status string

The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.

validations LdapVerifyValidation[]

Array of validation messages related to the verification of the provided LDAP over TLS/SSL configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. The following return values can be seen here: Values

id str

The provider-assigned unique ID for this managed resource.

links Sequence[LdapVerifyLink]

One or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.

request_id str

The unique identifier for the request to verify the LDAP over TLS/SSL configuration.

status str

The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.

validations Sequence[LdapVerifyValidation]

Array of validation messages related to the verification of the provided LDAP over TLS/SSL configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. The following return values can be seen here: Values

id String

The provider-assigned unique ID for this managed resource.

links List<Property Map>

One or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.

requestId String

The unique identifier for the request to verify the LDAP over TLS/SSL configuration.

status String

The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.

validations List<Property Map>

Array of validation messages related to the verification of the provided LDAP over TLS/SSL configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. The following return values can be seen here: Values

Look up Existing LdapVerify Resource

Get an existing LdapVerify 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?: LdapVerifyState, opts?: CustomResourceOptions): LdapVerify
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authz_query_template: Optional[str] = None,
        bind_password: Optional[str] = None,
        bind_username: Optional[str] = None,
        ca_certificate: Optional[str] = None,
        hostname: Optional[str] = None,
        links: Optional[Sequence[LdapVerifyLinkArgs]] = None,
        port: Optional[int] = None,
        project_id: Optional[str] = None,
        request_id: Optional[str] = None,
        status: Optional[str] = None,
        validations: Optional[Sequence[LdapVerifyValidationArgs]] = None) -> LdapVerify
func GetLdapVerify(ctx *Context, name string, id IDInput, state *LdapVerifyState, opts ...ResourceOption) (*LdapVerify, error)
public static LdapVerify Get(string name, Input<string> id, LdapVerifyState? state, CustomResourceOptions? opts = null)
public static LdapVerify get(String name, Output<String> id, LdapVerifyState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AuthzQueryTemplate string

An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs. Used only for user authorization. Use the {USER} placeholder in the URL to substitute the authenticated username. The query is relative to the host specified with hostname. The formatting for the query must conform to RFC4515 and RFC 4516. If you do not provide a query template, Atlas attempts to use the default value: {USER}?memberOf?base.

BindPassword string

The password used to authenticate the bind_username.

BindUsername string

The user DN that Atlas uses to connect to the LDAP server. Must be the full DN, such as CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com.

CaCertificate string

CA certificate used to verify the identify of the LDAP server. Self-signed certificates are allowed.

Hostname string

The hostname or IP address of the LDAP server. The server must be visible to the internet or connected to your Atlas cluster with VPC Peering.

Links List<LdapVerifyLinkArgs>

One or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.

Port int

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

ProjectId string

The unique ID for the project to configure LDAP.

RequestId string

The unique identifier for the request to verify the LDAP over TLS/SSL configuration.

Status string

The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.

Validations List<LdapVerifyValidationArgs>

Array of validation messages related to the verification of the provided LDAP over TLS/SSL configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. The following return values can be seen here: Values

AuthzQueryTemplate string

An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs. Used only for user authorization. Use the {USER} placeholder in the URL to substitute the authenticated username. The query is relative to the host specified with hostname. The formatting for the query must conform to RFC4515 and RFC 4516. If you do not provide a query template, Atlas attempts to use the default value: {USER}?memberOf?base.

BindPassword string

The password used to authenticate the bind_username.

BindUsername string

The user DN that Atlas uses to connect to the LDAP server. Must be the full DN, such as CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com.

CaCertificate string

CA certificate used to verify the identify of the LDAP server. Self-signed certificates are allowed.

Hostname string

The hostname or IP address of the LDAP server. The server must be visible to the internet or connected to your Atlas cluster with VPC Peering.

Links []LdapVerifyLinkArgs

One or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.

Port int

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

ProjectId string

The unique ID for the project to configure LDAP.

RequestId string

The unique identifier for the request to verify the LDAP over TLS/SSL configuration.

Status string

The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.

Validations []LdapVerifyValidationArgs

Array of validation messages related to the verification of the provided LDAP over TLS/SSL configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. The following return values can be seen here: Values

authzQueryTemplate String

An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs. Used only for user authorization. Use the {USER} placeholder in the URL to substitute the authenticated username. The query is relative to the host specified with hostname. The formatting for the query must conform to RFC4515 and RFC 4516. If you do not provide a query template, Atlas attempts to use the default value: {USER}?memberOf?base.

bindPassword String

The password used to authenticate the bind_username.

bindUsername String

The user DN that Atlas uses to connect to the LDAP server. Must be the full DN, such as CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com.

caCertificate String

CA certificate used to verify the identify of the LDAP server. Self-signed certificates are allowed.

hostname String

The hostname or IP address of the LDAP server. The server must be visible to the internet or connected to your Atlas cluster with VPC Peering.

links List<LdapVerifyLinkArgs>

One or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.

port Integer

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

projectId String

The unique ID for the project to configure LDAP.

requestId String

The unique identifier for the request to verify the LDAP over TLS/SSL configuration.

status String

The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.

validations List<LdapVerifyValidationArgs>

Array of validation messages related to the verification of the provided LDAP over TLS/SSL configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. The following return values can be seen here: Values

authzQueryTemplate string

An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs. Used only for user authorization. Use the {USER} placeholder in the URL to substitute the authenticated username. The query is relative to the host specified with hostname. The formatting for the query must conform to RFC4515 and RFC 4516. If you do not provide a query template, Atlas attempts to use the default value: {USER}?memberOf?base.

bindPassword string

The password used to authenticate the bind_username.

bindUsername string

The user DN that Atlas uses to connect to the LDAP server. Must be the full DN, such as CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com.

caCertificate string

CA certificate used to verify the identify of the LDAP server. Self-signed certificates are allowed.

hostname string

The hostname or IP address of the LDAP server. The server must be visible to the internet or connected to your Atlas cluster with VPC Peering.

links LdapVerifyLinkArgs[]

One or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.

port number

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

projectId string

The unique ID for the project to configure LDAP.

requestId string

The unique identifier for the request to verify the LDAP over TLS/SSL configuration.

status string

The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.

validations LdapVerifyValidationArgs[]

Array of validation messages related to the verification of the provided LDAP over TLS/SSL configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. The following return values can be seen here: Values

authz_query_template str

An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs. Used only for user authorization. Use the {USER} placeholder in the URL to substitute the authenticated username. The query is relative to the host specified with hostname. The formatting for the query must conform to RFC4515 and RFC 4516. If you do not provide a query template, Atlas attempts to use the default value: {USER}?memberOf?base.

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. Must be the full DN, such as CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com.

ca_certificate str

CA certificate used to verify the identify of the LDAP server. Self-signed certificates are allowed.

hostname str

The hostname or IP address of the LDAP server. The server must be visible to the internet or connected to your Atlas cluster with VPC Peering.

links Sequence[LdapVerifyLinkArgs]

One or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.

port int

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

project_id str

The unique ID for the project to configure LDAP.

request_id str

The unique identifier for the request to verify the LDAP over TLS/SSL configuration.

status str

The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.

validations Sequence[LdapVerifyValidationArgs]

Array of validation messages related to the verification of the provided LDAP over TLS/SSL configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. The following return values can be seen here: Values

authzQueryTemplate String

An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs. Used only for user authorization. Use the {USER} placeholder in the URL to substitute the authenticated username. The query is relative to the host specified with hostname. The formatting for the query must conform to RFC4515 and RFC 4516. If you do not provide a query template, Atlas attempts to use the default value: {USER}?memberOf?base.

bindPassword String

The password used to authenticate the bind_username.

bindUsername String

The user DN that Atlas uses to connect to the LDAP server. Must be the full DN, such as CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com.

caCertificate String

CA certificate used to verify the identify of the LDAP server. Self-signed certificates are allowed.

hostname String

The hostname or IP address of the LDAP server. The server must be visible to the internet or connected to your Atlas cluster with VPC Peering.

links List<Property Map>

One or more links to sub-resources. The relations in the URLs are explained in the Web Linking Specification.

port Number

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

projectId String

The unique ID for the project to configure LDAP.

requestId String

The unique identifier for the request to verify the LDAP over TLS/SSL configuration.

status String

The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.

validations List<Property Map>

Array of validation messages related to the verification of the provided LDAP over TLS/SSL configuration details. The array contains a document for each test that Atlas runs. Atlas stops running tests after the first failure. The following return values can be seen here: Values

Supporting Types

Href string
Rel string
Href string
Rel string
href String
rel String
href string
rel string
href str
rel str
href String
rel String

LdapVerifyValidation

Status string

The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.

ValidationType string
Status string

The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.

ValidationType string
status String

The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.

validationType String
status string

The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.

validationType string
status str

The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.

validation_type str
status String

The current status of the LDAP over TLS/SSL configuration. One of the following values: PENDING, SUCCESS, and FAILED.

validationType String

Import

LDAP Configuration must be imported using project ID and request ID, e.g.

 $ pulumi import mongodbatlas:index/ldapVerify:LdapVerify test 5d09d6a59ccf6445652a444a-5d09d6a59ccf6445652a444a

For more information seeMongoDB Atlas API Reference.

Package Details

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

This Pulumi package is based on the mongodbatlas Terraform Provider.