OBTER /api/atlas/v1.0/groups/{groupId}/userSecurity

Retorna a configuração LDAP atual para o projeto especificado.

Requisitos de função
  • Proprietário do projeto

parâmetros de caminho

  • groupId string Obrigatório

    Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.

    AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.

    O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

parâmetros de query

  • envelope booleano

    Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.

    O valor padrão é false.

  • pretty booleano

    Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

    O valor padrão é false.

    Prettyprint

Respostas

  • 200 aplicação/json

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • customerX509 objeto

      Configurações para configurar certificados TLS para usuários de banco de dados.

      Ocultar atributos customerX509 Mostrar atributos customerX509 objeto
      • cas string

        Lista concatenada de certificados de autoridade de certificação (CA) do cliente necessários para autenticar usuários do banco de dados . O MongoDB Cloud espera isso como um certificado formatado em PEM.

    • ldap objeto

      Detalhes de configuração LDAP (Lightweight Directory Access Protocol) sobre TLS (Transport Layer Security) que se aplicam ao projeto especificado.

      Ocultar atributos ldap Mostrar atributos ldap objeto
      • authenticationEnabled booleano

        Sinalizador que indica se os usuários podem autenticar usando um host LDAP (Lightweight Directory Access Protocol).

      • authorizedEnabled booleano

        Sinalizador que indica se os usuários podem autorizar o acesso aos recursos do MongoDB Cloud usando um host LDAP (Lightweight Directory Access Protocol).

      • authzQueryTemplate string

        Modelo de query LDAP (Lightweight Directory Access Protocol) que o MongoDB Cloud executa para obter os grupos LDAP associados ao usuário autenticado. O MongoDB Cloud usa este parâmetro apenas para a autorização do usuário. Use o {USER} espaço reservado no Localizador de recursos uniforme (URL) para substituir o nome de usuário autenticado. A query está relacionada ao host especificado com o nome do host. Formate esta consulta de acordo com RFC 4515 e RFC 4516.

        O valor padrão é {USER}?memberOf?base.

      • bindUsername string

        Nome distintivo (DN) completo do usuário LDAP (Lightweight Directory Access Protocol) que o MongoDB Cloud usa para se conectar ao host LDAP. Os nomes distintivos do LDAP devem ser formatados de acordo com a RFC 2253.

        O formato deve corresponder ao seguinte padrão: ^(?:(?<cn>CN=(?<name>[^,]*)),)?(?:(?<path>(?:(?:CN|OU)=[^,]+,?)+),)?(?<domain>(?:DC=[^,]+,?)+)$.

        RFC 2253
      • caCertificate string

        Certificado de autoridade de certificação (CA) que o MongoDB Cloud usa para verificar a identidade do host LDAP (Lightweight Directory Access Protocol). MongoDB Cloud permite certificados autoassinados. Para excluir um valor atribuído, passe uma string vazia: "caCertificate": "".

      • nome do host string

        Etiqueta legível por humanos que identifica o nome do host ou o endereço IP (Internet Protocol) do host LDAP (Lightweight Directory Access Protocol). Esse host deve ter acesso à Internet ou ter uma conexão de emparelhamento de nuvem privada virtual (VPC) com seu cluster.

        O formato deve corresponder ao seguinte padrão: ^([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]+)?$.

      • Porta integer(int32)

        Porta para a qual o host LDAP (Lightweight Directory Access Protocol) escuta conexões de cliente .

        O valor padrão é 636.

      • userToDNMapping array[objeto]

        Mapa de usuário para nome distinto (DN) que o MongoDB Cloud usa para transformar um nome de usuário LDAP (Lightweight Directory Access Protocol) em um DN LDAP.

        Ocultar atributos userToDNMapping Mostrar atributos userToDNMapping objeto

        Mapa de usuário para nome distinto (DN) que o MongoDB Cloud usa para transformar um nome de usuário LDAP (Lightweight Directory Access Protocol) em um DN LDAP.

        • ldapQuery string

          Modelo de consulta LDAP (Lightweight Directory Access Protocol) que insere o nome LDAP que a expressão regular corresponde a um URI de consulta LDAP. A formatação da query deve estar em conformidade com RFC 4515 e RFC 4516.

        • corresponder string Obrigatório

          expressão regular que o MongoDB Cloud usa para corresponder ao nome de usuário Lightweight Directory Access Protocol (LDAP) fornecido. Cada seção entre parênteses representa um grupo de captura de expressão regular que o modelo de substituição ou ldapQuery utiliza.

        • substituição string

          Modelo de Nome Distinto (DN) do LDAP (Lightweight Directory Access Protocol) que converte o nome de usuário LDAP que corresponde à expressão regular no parâmetro de correspondência em um Nome Distinto (DN) LDAP.

  • 401 aplicação/json

    Não autorizado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 403 aplicação/json

    Forbidden.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 404 aplicação/json

    Não encontrado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 500 aplicação/json

    Erro interno do servidor.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

GET /API/atlas/v1.0/groups/{groupId}/userSecurity
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/userSecurity' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Exemplos de resposta (200)
{
  "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"
    }
  ]
}
Exemplos de resposta (401)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 401,
  "errorCode": "NOT_ORG_GROUP_CREATOR",
  "reason": "Unauthorized"
}
Exemplos de resposta (403)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 403,
  "errorCode": "CANNOT_CHANGE_GROUP_NAME",
  "reason": "Forbidden"
}
Exemplos de resposta (404)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "error": 404,
  "errorCode": "RESOURCE_NOT_FOUND",
  "reason": "Not Found"
}
Exemplos de resposta (500)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 500,
  "errorCode": "UNEXPECTED_ERROR",
  "reason": "Internal Server Error"
}