Obter a configuração da API de dados

OBTER /groups/{groupId}/apps/{appId}/data_api/config
tokenAuth

Obtenha a configuração da API de dados do seu aplicativo.

parâmetros de caminho

Respostas

  • 200 aplicação/json

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto | zero
    • desabilitado booleano Obrigatório
    • versões array[string] Obrigatório

      Uma versão compatível da Data API.

      O valor é v1.

    • return_type string Obrigatório

      Um formato de dados compatível com a Data API e endpoints personalizados.

      Os valores são JSON ou EJSON.

    • create_user_on_auth booleano
    • run_as_user_id string

      ID da conta de um usuário do aplicativo. Se definidos, os endpoints sempre serão executados da forma como o usuário especificou.

    • run_as_user_id_script_source string

      Código fonte em string para uma função que retorna o ID da conta de um usuário do aplicativo. Se definidos, os endpoints executam a função em cada solicitação e são executados como o usuário com o ID retornado da função.

    • validation_method string Obrigatório

      Os valores são NO_VALIDATION, SECRET_AS_QUERY_PARAM ou VERIFY_PAYLOAD.

    • secret_name string

      Se validation_method estiver definido como "SECRET_AS_QUERY_PARAM" ou "VERIFY_PAYLOAD", este é o name do Segredo que autoriza as solicitações.

    • can_evaluate objeto

      Uma expressão JSON que avalia para true se um endpoint for permitido ser executado em resposta a uma solicitação recebida.
GET /groups/{groupId}/apps/{appId}/data_api/config 
curl \
 --request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/data_api/config' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Exemplos de resposta (200) 
{
  "disabled": true,
  "versions": [
    "v1"
  ],
  "return_type": "JSON",
  "create_user_on_auth": true,
  "run_as_user_id": "string",
  "run_as_user_id_script_source": "string",
  "validation_method": "NO_VALIDATION",
  "secret_name": "string",
  "can_evaluate": {}
}