Deshabilitar X.509 gestionado por el cliente

ELIMINAR /api/atlas/v2/grupos/{ID de grupo}/seguridad del usuario/clienteX509

Borra la configuración de X.509 administrada por el cliente en un proyecto, incluida la autoridad de certificación cargada, lo que deshabilita X.509 autoadministrado.

Al actualizar esta configuración, se activa un reinicio continuo de la base de datos. Debe tener el rol de Propietario del proyecto para usar este punto de conexión.

Parámetros de ruta

  • ID de grupo string Requerido

    Cadena 24hexadecimal única que identifica su proyecto. Utilice el punto de conexión /groups para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.

    NOTA: Grupos y proyectos son términos sinónimos. El ID de tu grupo es el mismo que el de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. El recurso y los puntos finales correspondientes usan el término "grupos".

    El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

Parámetros de consulta

  • envolvente booleano

    Indicador que indica si la aplicación encapsula la respuesta en un objeto JSON envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.

    El valor predeterminado es false.

Respuestas

  • 202 application/vnd.atlas.2023-01-01+json

    Aceptado

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • customerX509 Objeto

      Configuraciones para configurar certificados TLS para usuarios de bases de datos.

      Ocultar atributos de customerX509 Mostrar atributos de customerX509 Objeto
      • caso string

        Lista concatenada de certificados de la autoridad de certificación (CA) del cliente necesarios para autenticar a los usuarios de la base de datos. MongoDB Cloud espera que sea un certificado con formato PEM.

    • ldap Objeto

      Detalles de configuración del Protocolo ligero de acceso a directorios (LDAP) sobre seguridad de la capa de transporte (TLS) que se aplican al proyecto especificado.

      Ocultar atributos ldap Mostrar atributos ldap Objeto
      • autenticación habilitada booleano

        Bandera que indica si los usuarios pueden autenticarse mediante un host de Protocolo ligero de acceso a directorios (LDAP).

      • autorización habilitada booleano

        Bandera que indica si los usuarios pueden autorizar el acceso a los recursos de MongoDB Cloud utilizando un host de Protocolo Ligero de Acceso a Directorios (LDAP).

      • Plantilla de consulta de autenticación string

        Plantilla de consulta del Protocolo Ligero de Acceso a Directorios (LDAP) que MongoDB Cloud ejecuta para obtener los grupos LDAP asociados al usuario autenticado. MongoDB Cloud utiliza este parámetro solo para la autorización de usuarios. Utilice el {USER} marcador en el Localizador Uniforme de Recursos (URL) para sustituir el nombre de usuario autenticado. La consulta se relaciona con el host especificado con el nombre de host. Formatee esta consulta según las RFC 4515 y 4516RFC.

        El valor predeterminado es {USER}?memberOf?base.

      • bindUsername string

        Nombre distinguido (DN) completo del usuario del Protocolo ligero de acceso a directorios (LDAP) que MongoDB Cloud utiliza para conectarse al host LDAP. Los nombres distinguidos LDAP deben tener el formato RFC 2253.

        El formato debe coincidir con el siguiente patrón: ^(?:(?<cn>CN=(?<name>[^,]*)),)?(?:(?<path>(?:(?:CN|OU)=[^,]+,?)+),)?(?<domain>(?:DC=[^,]+,?)+)$.

        Solicitud de comentarios 2253
      • caCertificate string

        Certificado de autoridad de certificación (CA) que MongoDB Cloud utiliza para verificar la identidad del host LDAP (Protocolo ligero de acceso a directorios). MongoDB Cloud permite certificados autofirmados. Para eliminar un valor asignado, pase una cadena vacía: "caCertificate": "".

      • Nombre del host string

        Etiqueta legible que identifica el nombre de host o la dirección IP del host LDAP (Protocolo ligero de acceso a directorios). Este host debe tener acceso a internet o una conexión de peering de nube privada virtual (VPC) con el clúster.

        El formato debe coincidir con el siguiente patrón: ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?$.

      • Puerto integer(int32)

        Puerto en el que el host del Protocolo ligero de acceso a directorios (LDAP) escucha las conexiones del cliente.

        El valor predeterminado es 636.

      • usuarioAAsignaciónDN matriz[objeto]

        Mapa de usuario a nombre distinguido (DN) que MongoDB Cloud utiliza para transformar un nombre de usuario de protocolo ligero de acceso a directorios (LDAP) en un DN LDAP.

        Mapa de usuario a nombre distinguido (DN) que MongoDB Cloud utiliza para transformar un nombre de usuario de protocolo ligero de acceso a directorios (LDAP) en un DN LDAP.

        Ocultar atributos userToDNMapping Mostrar atributos userToDNMapping Objeto
        • Consulta ldap string

          Plantilla de consulta del Protocolo Ligero de Acceso a Directorios (LDAP) que inserta el nombre LDAP que coincide con la expresión regular en un Identificador Uniforme de Recursos (URI) de consulta LDAP. El formato de la consulta debe cumplir con las normas RFC 4515 y 4516 RFC.

        • coincidencia string Requerido

          Expresión regular que MongoDB Cloud utiliza para comparar con el nombre de usuario del Protocolo Ligero de Acceso a Directorios (LDAP) proporcionado. Cada sección entre paréntesis representa un grupo de captura de expresiones regulares que utiliza la plantilla de sustitución o ldapQuery.

        • sustitución string

          Plantilla de nombre distintivo (DN) del Protocolo ligero de acceso a directorios (LDAP) que convierte el nombre de usuario LDAP que coincide con la expresión regular en el parámetro de coincidencia en un nombre distintivo (DN) LDAP.

  • 401 aplicación/json

    No autorizado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 403 aplicación/json

    Forbidden.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 404 aplicación/json

    No se encontró.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 500 aplicación/json

    Error Interno del Servidor.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

ELIMINAR /api/atlas/v2/grupos/{groupId}/userSecurity/clienteX509
atlas api x509Authentication disableSecurityCustomerX509 --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20231001001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.DisableGroupUserSecurityCustomerX509ApiParams{}
	httpResp, err := client.X509AuthenticationApi.
		DisableGroupUserSecurityCustomerX509WithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-10-01+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-10-01+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509"
Ejemplos de respuestas (202)
{
  "customerX509": {
    "cas": "string",
    "links": [
      {
        "href": "https://cloud.mongodb.com/api/atlas",
        "rel": "self"
      }
    ]
  },
  "ldap": {
    "authenticationEnabled": true,
    "authorizationEnabled": true,
    "authzQueryTemplate": "{USER}?memberOf?base",
    "bindUsername": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
    "caCertificate": "string",
    "hostname": "string",
    "links": [
      {
        "href": "https://cloud.mongodb.com/api/atlas",
        "rel": "self"
      }
    ],
    "port": 636,
    "userToDNMapping": [
      {
        "ldapQuery": "string",
        "match": "(.*)",
        "substitution": "CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com"
      }
    ]
  },
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ]
}
Ejemplos de respuestas (401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Ejemplos de respuestas (403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Ejemplos de respuestas (404)
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
Ejemplos de respuestas (500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}