gcloud active-directory domains update-ldaps-settings

NAME
gcloud active-directory domains update-ldaps-settings - update the LDAPS settings for a domain
SYNOPSIS
gcloud active-directory domains update-ldaps-settingsDOMAIN(--clear-certificates    | [--certificate-pfx-file=PATH_TO_FILE :--certificate-password=CERTIFICATE_PASSWORD])[--async][GCLOUD_WIDE_FLAG …]
DESCRIPTION
Update a Managed Microsoft AD domain's Lightweight Directory Access Protocolover TLS/SSL (LDAPS) settings. You must be safelisted for the Managed AD LDAPSAlpha in order to use this feature. Consult the API documentation for a list ofcertificate requirements.

This command can fail for the following reasons:

  • The certificate is invalid.
  • The domain specified does not exist.
  • The active account does not have permission to view LDAPS settings for thedomain.
EXAMPLES
To enable LDAPS for the first time or update the certificates being used:
gcloudactive-directorydomainsupdate-ldaps-settingsmy-domain.com--certificate-pfx-file=certificate-chain-with-private-key.pfx--certificate-password="password"

To disable LDAPS:

gcloudactive-directorydomainsupdate-ldaps-settingsmy-domain.com--clear-certificates
POSITIONAL ARGUMENTS
Domain resource - Name of the managed Managed Microsoft AD domain you want toupdate. This represents a Cloud resource. (NOTE) Some attributes are not givenarguments in this group but can be set in other ways.

To set theproject attribute:

  • provide the argumentdomain on the command line with a fullyspecified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

DOMAIN
ID of the domain or fully qualified identifier for the domain.

To set thedomain attribute:

  • provide the argumentdomain on the command line.
REQUIRED FLAGS
Exactly one of these must be specified:
--clear-certificates
Disable LDAPS by deleting all existing certificates. Certificates will need tobe re-uploaded if LDAPS is to be re-enabled.
Or at least one of these can be specified:
--certificate-pfx-file=PATH_TO_FILE
PKCS#12-formatted pfx file that specifies the certificate chain used toconfigure LDAPS. If certificate-password is not specified, command will promptuser for secret. Use a full or relative path to a local file containing thevalue of certificate_pfx_file.

This flag argument must be specified if any of the other arguments in this groupare specified.

--certificate-password=CERTIFICATE_PASSWORD
Password used to encrypt the PKCS#12 certificate. If not specified, command willprompt user for secret.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to complete.
GCLOUD WIDE FLAGS
These flags are available to all commands:--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.

Run$gcloud help for details.

API REFERENCE
This command uses themanagedidentities/v1 API. The fulldocumentation for this API can be found at:https://cloud.google.com/managed-microsoft-ad/
NOTES
These variants are also available:
gcloudalphaactive-directorydomainsupdate-ldaps-settings
gcloudbetaactive-directorydomainsupdate-ldaps-settings

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-01-21 UTC.