mongocli atlas security ldap verify status

On this page

Syntax

Arguments
Options
Output
Example

This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of MongoCLI.

The security ldap verify status command retrieves the status of the most recent verification request submitted using the mongocli atlas security ldap verify command or the Atlas API. You can also retrieve the status of a verification request using the Atlas API.

Note

Atlas returns a HTTP 404 error if you request the status of any request other than the most recent.

Syntax

mongocli atlas security ldap verify <request-ID>
     [ --output|-o <output-format> ]
     [ --profile|-P <name-of-profile> ]
     [ --projectId <id-of-project> ]

Note

Use -h or --help to view the command-line help for this command.

Arguments

Argument	Type	Description	Required?
<request-ID>	string	Unique identifier of the most recent request to verify the LDAP over TLS/SSL configuration. Run the mongocli atlas security ldap verify command for the request ID.	yes

Options

Option	Type	Description	Required?
`--output`, `-o`	string	Command output format. Valid values are: `json` for output in JSON format `go-template` for custom output using the Go template `go-template-file` for custom output specified using Go template file If omitted, the command returns output in the default format.	no
`--profile`, `-P`	string	Name of the profile to use for accessing the Atlas project. If omitted, uses the default profile.	no
`--projectId`	string	Unique identifier of the project. If omitted, uses the project ID in the profile or environment variable.	yes

Output

If the command succeeds, it returns the following output in the default format. If the command returns errors, see Troubleshooting for recommended solutions.

REQUEST ID                 PROJECT ID           STATUS
<verification-request-ID>  <atlas-project-ID>   <verification-status>

The default output contains a subset of the fields returned by this command. For the complete list of JSON fields returned by the command, see the API reference.

Example

The following example uses the mongocli atlas security ldap verify status command to retrieve the status of the most recent request for verification of an LDAP over TLS configuration. The command uses the default profile to access the Atlas project.

mongocli atlas security ldap verify status 5fa1afa40bcb85015ae356ec

The previous command prints the following to the terminal:

REQUEST ID                 PROJECT ID                 STATUS
5fa1afa40bcb85015ae356ec   5e2211c17a3e5a48f5497de3   SUCCESS

mongocli atlas security ldap verify status 5fa1afa40bcb85015ae356ec --output json

The previous command prints the following fields to the terminal:

{
  "requestId": "5fa1afa40bcb85015ae356ec",
  "groupId": "5e2211c17a3e5a48f5497de3",
  "request": {
    "hostname": "atlas-ldaps-01.ldap.myteam.com",
    "port": 636,
    "bindUsername": "CN=Administrator,CN=Users,DC=atlas-ldaps-01,DC=myteam,DC=com"
  },
  "status": "SUCCESS",
  "validations": [
    {
      "status": "OK",
      "validationType": "SERVER_SPECIFIED"
    },
    {
      "status": "OK",
      "validationType": "CONNECT"
    },
    {
      "status" : "OK",
      "validationType" : "AUTHENTICATE"
    },
    {
      "status" : "OK",
      "validationType" : "AUTHORIZATION_ENABLED"
    },
    {
      "status" : "OK",
      "validationType" : "PARSE_AUTHZ_QUERY_TEMPLATE"
    },
    {
      "status" : "OK",
      "validationType" : "QUERY_SERVER"
    }
  ],
  "links": [
    {
      "rel": "self",
      "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/5e2211c17a3e5a48f5497de3/userSecurity/ldap/verify/5fa1afa40bcb85015ae356ec"
    }
  ]
}

Back

Verify an LDAP Configuration

Watch LDAP Configuration Request