Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--mongodb-atlas-ldapconfiguration.json
Parent schema serverless-framework-configuration
Type: object

Returns, edits, verifies, and removes LDAP configurations.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git

Properties

BindUsername string | Aws_CF_FunctionString required

Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.

Hostname string | Aws_CF_FunctionString required

Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.

BindPassword string | Aws_CF_FunctionString required

Password that MongoDB Cloud uses to authenticate the bindUsername.

ProjectId string | Aws_CF_FunctionString required

Unique 24-hexadecimal digit string that identifies your project.

Port integer required

Port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections.

Profile string | Aws_CF_FunctionString

Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used

Status string | Aws_CF_FunctionString

The current status of the LDAP over TLS/SSL configuration.

AuthenticationEnabled boolean

Flag that indicates whether users can authenticate using an Lightweight Directory Access Protocol (LDAP) host.

AuthorizationEnabled boolean

Flag that indicates whether users can authorize access to MongoDB Cloud resources using an Lightweight Directory Access Protocol (LDAP) host.

CaCertificate string | Aws_CF_FunctionString

Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: "caCertificate": ""

AuthzQueryTemplate string | Aws_CF_FunctionString

Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud runs to obtain the LDAP groups associated with the authenticated user. MongoDB Cloud uses this parameter only for user authorization. Use the {USER} placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query according to RFC 4515 and RFC 4516.

UserToDNMapping object[]

User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.

Definitions

ApiAtlasNDSUserToDNMappingView object
LdapQuery string | Aws_CF_FunctionString

Lightweight Directory Access Protocol (LDAP) query template that inserts the LDAP name that the regular expression matches into an LDAP query Uniform Resource Identifier (URI). The formatting for the query must conform to RFC 4515 and RFC 4516.

Match string | Aws_CF_FunctionString

Regular expression that MongoDB Cloud uses to match against the provided Lightweight Directory Access Protocol (LDAP) username. Each parenthesis-enclosed section represents a regular expression capture group that the substitution or ldapQuery template uses.

Substitution string | Aws_CF_FunctionString

Lightweight Directory Access Protocol (LDAP) Distinguished Name (DN) template that converts the LDAP username that matches regular expression in the match parameter into an LDAP Distinguished Name (DN).