VISO TRUST
oficialAcesse e gerencie seu programa de
O que você pode fazer com VISO TRUST MCP?
- Consultar avaliações de fornecedores — Recupere uma avaliação específica pelo ID, incluindo o resumo gerado por IA em HTML ou Markdown.
- Criar e gerenciar avaliações — Inicie uma avaliação para um relacionamento existente, atualize a data de expiração ou ajuste as configurações de acompanhamento.
- Pesquisar relacionamentos com fornecedores — Filtre relacionamentos por tags, domínios, status, níveis de risco, faixas de pontuação, unidades de negócios e datas.
- Integrar ou desativar fornecedores — Integre um relacionamento com um resumo de aprovação e configurações de ciclo de vida, ou desative e arquive-o.
- Revisar logs de auditoria — Consulte eventos de auditoria de usuários, organizações, avaliações e relacionamentos dentro de um intervalo de datas.
- Gerenciar relatórios de inteligência — Crie, atualize ou busque relatórios do BitSight, SecurityScorecard e Recorded Future para um domínio de fornecedor.
Documentação
Servidor MCP VISO TRUST
Um servidor Model Context Protocol (MCP) para integrar os recursos da API VISO TRUST a assistentes de IA.
Servidor remoto hospedado
A VISO TRUST hospeda uma instância gerenciada deste servidor MCP, então você não precisa criar, executar nem hospedar nada por conta própria para começar:
https://mcp.visotrust.com/mcp
Conecte qualquer cliente MCP a este endpoint usando o transporte Streamable HTTP e autentique-se com seu token de API VISO TRUST. Para saber como gerar um token de API, consulte a documentação de suporte da VISO TRUST.
Exemplo de configuração do cliente:
{
"mcpServers": {
"viso-mcp": {
"type": "streamable-http",
"url": "https://mcp.visotrust.com/mcp",
"headers": {
"Authorization": "Bearer <your-api-token>"
}
}
}
}
Para testar o endpoint hospedado com o MCP Inspector, execute npx @modelcontextprotocol/inspector, defina Transport Type como Streamable HTTP e use a URL acima.
O restante deste documento aborda como executar o servidor por conta própria (localmente ou na sua própria infraestrutura).
Requisitos
- Java 21+
- Gradle
- Docker (opcional para implantação em contêiner)
- MCP Inspector (opcional para testes)
Configuração
Configuração da API VISO TRUST
As propriedades a seguir podem ser configuradas para a API VISO TRUST:
visotrust.api.base-url: URL base da API VISO TRUST (padrão: http://localhost:8080)visotrust.api.token: Seu token de API da plataforma VISO TRUST (obrigatório)visotrust.api.timeout: Tempo limite das solicitações à API, em milissegundos (padrão: 30000)visotrust.api.connect-timeout: Tempo limite de conexão com a API, em milissegundos (padrão: 5000)
Para saber como gerar um token de API para a variável de ambiente visotrust.api.token, consulte a documentação de suporte da VISO TRUST.
Perfis da aplicação
Esta aplicação oferece suporte a perfis do Spring Boot para habilitar diferentes configurações em diferentes cenários de implantação.
Perfil remoto
O perfil remote foi projetado para suporte remoto a MCP pelo transporte Streamable HTTP. Esse perfil executa o servidor como uma aplicação web para que ele possa se comunicar com clientes remotos por HTTP. (O Streamable HTTP substitui o transporte SSE obsoleto; aqui, ele é configurado no modo sem estado.)
Principais diferenças do perfil remoto:
- Executa como uma aplicação web servlet (Tomcat) na porta
3001, em vez de usar entrada/saída padrão - Expõe o endpoint MCP em
POST /mcp(Streamable HTTP) - Executa no modo sem estado — não mantém estado do servidor por sessão, permitindo escalabilidade horizontal atrás de um balanceador de carga sem exigir afinidade de sessão
- Configurações do servidor otimizadas para conexões de clientes remotos
- Registro em log aprimorado para depuração distribuída
Observação: Os clientes se conectam ao único endpoint Streamable HTTP
…/mcp. Os endpoints SSE legados (/sse+/mcp/message) não são mais disponibilizados.
Como ativar o perfil remoto:
Ao executar diretamente com Java:
java -jar viso-mcp-server-<version>.jar --spring.profiles.active=remote
Ao executar com Gradle:
./gradlew bootRun --args="--spring.profiles.active=remote"
Ao usar Docker:
docker run -i --rm \
-e VISOTRUST_API_TOKEN=<your-api-token> \
-e SPRING_PROFILES_ACTIVE=remote \
viso-mcp-server
Quando usar o perfil remoto:
- Ao implantar o servidor MCP em um servidor remoto ou ambiente de nuvem
- Quando os clientes se conectarem por Streamable HTTP, em vez de stdio direto
- Quando precisar de registro em log e monitoramento aprimorados para implantações distribuídas
- Ao integrar com assistentes de IA baseados na web que se conectam por Streamable HTTP
Para desenvolvimento local e comunicação direta por stdio, use o perfil padrão (não é necessário especificar um perfil).
Instalação
Instalação rápida
Clique em um dos botões abaixo para instalar o servidor MCP VISO no VS Code:
Configuração manual com VS Code
Adicione o seguinte bloco JSON ao arquivo User Settings (JSON) no VS Code. Para isso, pressione Ctrl + Shift + P e digite Preferences: Open User Settings (JSON).
{
"mcp": {
"inputs": [
{
"type": "promptString",
"id": "viso_baseurl",
"description": "VISO TRUST API Base URL",
"default": "https://app.visotrust.com"
},
{
"type": "promptString",
"id": "viso_token",
"description": "VISO TRUST API Token",
"password": true
}
],
"servers": {
"viso-mcp": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"VISOTRUST_API_TOKEN",
"-e",
"VISOTRUST_API_BASEURL",
"visotrustai/viso-mcp-server:latest"
],
"env": {
"VISOTRUST_API_BASEURL": "${input:viso_baseurl}",
"VISOTRUST_API_TOKEN": "${input:viso_token}"
}
}
}
}
}
Opcionalmente, você pode adicionar um exemplo semelhante (ou seja, sem a chave mcp) a um arquivo chamado .vscode/mcp.json no seu espaço de trabalho. Isso permitirá compartilhar a configuração com outras pessoas.
{
"inputs": [
{
"type": "promptString",
"id": "viso_baseurl",
"description": "VISO TRUST API Base URL",
"default": "https://app.visotrust.com"
},
{
"type": "promptString",
"id": "viso_token",
"description": "VISO TRUST API Token",
"password": true
}
],
"servers": {
"viso-mcp": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"VISOTRUST_API_TOKEN",
"-e",
"VISOTRUST_API_BASEURL",
"visotrustai/viso-mcp-server:latest"
],
"env": {
"VISOTRUST_API_BASEURL": "${input:viso_baseurl}",
"VISOTRUST_API_TOKEN": "${input:viso_token}"
}
}
}
}
Uso com Claude Desktop e outros clientes MCP
Configuração do Docker
{
"mcpServers": {
"viso-mcp": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e", "VISOTRUST_API_TOKEN",
"-e", "VISOTRUST_API_BASEURL",
"visotrustai/viso-mcp-server:latest"
],
"env": {
"VISOTRUST_API_TOKEN": "<your-api-token>",
"VISOTRUST_API_BASEURL": "https://app.visotrust.com"
}
}
}
}
Configuração do Java
{
"mcpServers": {
"viso-mcp": {
"command": "java",
"args": [
"-jar",
"viso-mcp-server-<version>.jar",
"--port",
"8080",
"--host",
"localhost"
],
"env": {
"JAVA_TOOL_OPTIONS": "-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005",
"VISOTRUST_API_TOKEN": "<your-api-token>",
"VISOTRUST_API_BASEURL": "https://app.visotrust.com"
}
}
}
}
Observação: a variável de ambiente JAVA_TOOL_OPTIONS é usada para definir as opções da JVM para depuração remota. O endereço e a porta podem ser alterados conforme necessário.
💻 Desenvolvimento
Configuração do Docker
Criar imagem Docker
docker build -t viso-mcp-server .
Executar contêiner Docker
docker run -i --rm -e VISOTRUST_API_TOKEN=<your-api-token> viso-mcp-server
Depuração
Instalar o MCP Inspector
npm -g install @modelcontextprotocol/inspector
Executar o MCP Inspector para testes
- Criar o arquivo JAR do servidor MCP
./gradlew bootJar
- Executar o MCP Inspector
npx @modelcontextprotocol/inspector \
-e JAVA_TOOL_OPTIONS=-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=\*:5005 \
-e VISOTRUST_API_TOKEN=<your-api-token> \
java -jar build/libs/viso-mcp-server-<version>.jar \
--port 8080 --host localhost
Substitua <version> pela versão atual do projeto (por exemplo, 1.0.0 ou a versão da versão mais recente).
Pipeline de CI/CD
Este projeto usa o GitHub Actions para integração e implantação contínuas. O fluxo de trabalho inclui os seguintes trabalhos:
Lint
Verifica a formatação do código usando o Spotless:
./gradlew spotlessCheck
Build
Compila a aplicação e cria um arquivo JAR:
./gradlew build
Publicação
Quando uma nova versão é criada:
- Atualiza a versão do projeto em build.gradle para corresponder à tag da versão
- Envia o arquivo JAR para a versão do GitHub com a versão indicada pela tag
- Cria e envia a imagem Docker para o Docker Hub com as tags:
latest- A tag da versão (por exemplo,
v1.0.0)
Segredos necessários para publicação
Para habilitar a publicação no Docker Hub, adicione estes segredos ao seu repositório do GitHub:
DOCKERHUB_USERNAME: Seu nome de usuário do Docker HubDOCKERHUB_TOKEN: Seu token de acesso do Docker Hub
🛠️ Ferramentas
Esta seção documenta as ferramentas disponibilizadas pelo servidor MCP VISO. Cada ferramenta tem uma finalidade específica, parâmetros de entrada e formato de saída.
Avaliações
get_assessment - Obter uma avaliação pelo ID
- id: ID da avaliação (número, obrigatório)
Retorna informações detalhadas sobre uma avaliação específica.
get_assessment_summary - Obter o resumo de uma avaliação pelo ID
- id: ID da avaliação (número, obrigatório)
- format:
HTML(padrão) ouMARKDOWN(string, opcional)
Retorna o resumo, seu version e se ele foi edited.
update_assessment_summary - Substituir o texto do resumo de uma avaliação concluída, gerado por IA
- id: ID da avaliação (número, obrigatório)
- summary: Resumo editado (string, obrigatório)
- format:
HTML(padrão) ouMARKDOWN(string, opcional) - version: O
versiondeget_assessment_summary; a atualização será rejeitada se o resumo tiver sido alterado desde então (string, opcional)
Retorna o resumo atualizado no formato em que foi enviado.
create_assessment - Iniciar uma avaliação para um relacionamento existente
- relationshipId: ID do relacionamento para o qual criar uma avaliação (número, obrigatório)
- recipientEmail: Endereço de e-mail do destinatário da avaliação (string, opcional)
- recipientFirstName: Nome do destinatário da avaliação (string, opcional)
- recipientLastName: Sobrenome do destinatário da avaliação (string, opcional)
- publicDocumentUrls: URLs de documentos públicos a incluir na avaliação (string[], opcional)
- followupType: Tipo de acompanhamento (enum string, opcional)
- followupRiskThreshold: Limite de nível de risco que aciona o acompanhamento (enum string, opcional)
- followupTimeline: Cronograma das ações de acompanhamento (enum string, opcional)
- collectionTimeline: Prazo para o fornecedor concluir o envio da avaliação (enum string, opcional)
- noVendorResponseAction: Ação a tomar quando o fornecedor não responder (enum string, opcional)
- aiProcessingOnly: Se deve processar somente com IA, sem revisão humana (boolean, opcional)
- requestedAuditTypes: Tipos de auditoria solicitados para esta avaliação (string[], opcional)
Retorna os detalhes da avaliação criada.
update_assessment_expiration_date - Atualizar o prazo para o fornecedor enviar a resposta da avaliação
- id: ID da avaliação (número, obrigatório)
- expirationDate: Nova data/hora de expiração, ISO-8601 com deslocamento; deve estar no futuro (string, obrigatório)
Retorna uma mensagem de confirmação.
update_assessment_followup - Atualizar a configuração de acompanhamento de uma avaliação
- id: ID da avaliação (número, obrigatório)
- followupType: Tipo de acompanhamento (enum string, obrigatório)
- followupRiskThreshold: Limite de risco a partir do qual uma avaliação de acompanhamento deve ser acionada (enum string, opcional)
- followupTimeline: Cronograma de acompanhamento (enum string, opcional)
Retorna uma mensagem de confirmação.
Registros de auditoria
get_user_audit_log_events - Obter eventos de registro de auditoria no escopo do usuário da sua organização
- start: Data/hora inicial da consulta, ISO-8601 com deslocamento (string, obrigatório)
- end: Data/hora final da consulta, ISO-8601 com deslocamento (string, obrigatório)
- eventTypes: Conjunto opcional de tipos de evento para filtrar (por exemplo,
USER_LOGGED_IN); deixe vazio para incluir todos (string[], opcional)
Retorna uma lista de eventos de registro de auditoria do usuário, limitada a 500 registros.
get_audit_log_events - Obter eventos de registro de auditoria filtrados (eventos de usuário, organização, avaliação e relacionamento)
- start: Data/hora inicial da consulta, ISO-8601 com deslocamento (string, obrigatório)
- end: Data/hora final da consulta, ISO-8601 com deslocamento (string, obrigatório)
- eventTypes: Conjunto opcional de tipos de evento para filtrar (por exemplo,
ASSESSMENT_COMPLETED,RELATIONSHIP_CREATED); deixe vazio para incluir todos (string[], opcional)
Retorna registros polimórficos de eventos de auditoria. Cada item contém pelo menos auditEventType e dateTime.
Unidades de negócio
get_all_business_units - Obter todas as unidades de negócio da sua organização, ordenadas por nome
Retorna o id de cada unidade de negócio (utilizável como filtro businessUnitIds em search_relationships) e o name (utilizável como businessUnit em create_user).
Casos de negócio
get_all_business_cases - Obter todos os casos de negócio disponíveis para sua organização
Nenhum parâmetro obrigatório.
Retorna uma lista de todos os casos de negócio disponíveis para sua organização.
Tipos de dados
get_all_datatypes - Obter todos os tipos de dados disponíveis para sua organização
Nenhum parâmetro obrigatório.
Retorna uma lista de todos os tipos de dados disponíveis para sua organização.
Diretório de fornecedores
search_vendor_directory - Pesquisar um fornecedor no diretório de fornecedores da VISO TRUST por URL ou domínio
- urlOrDomain: URL ou nome de domínio a pesquisar, por exemplo,
example.com(string, obrigatório)
Retorna metadados básicos do fornecedor (nome, página inicial, descrição, favicon, domínios conhecidos).
Relacionamentos
get_all_relationships - Obter uma lista de todos os relacionamentos e os detalhes de suas avaliações
Nenhum parâmetro obrigatório.
Retorna informações sobre fornecedores terceirizados, incluindo o status das avaliações, níveis de risco e dados de contato.
get_relationship_by_id - Obter um relacionamento específico e os detalhes de suas avaliações pelo ID
- id: ID do relacionamento (número, obrigatório)
Retorna informações detalhadas sobre um fornecedor terceirizado, incluindo o status das avaliações, níveis de risco e dados de contato.
get_relationship_assessment_history - Obter o histórico de avaliações de um relacionamento
- id: ID do relacionamento (número, obrigatório)
Retorna uma lista de avaliações associadas ao relacionamento especificado.
create_relationship - Criar um novo relacionamento com um fornecedor terceirizado
- name: Nome do relacionamento/fornecedor (string, obrigatório)
- homepage: URL da página inicial do fornecedor (string, obrigatório)
- businessOwnerEmail: Endereço de e-mail do responsável pela área de negócio (string, obrigatório)
- businessOwnerFirstName: Nome do responsável pela área de negócio (string, opcional)
- businessOwnerLastName: Sobrenome do responsável pela área de negócio (string, opcional)
- description: Descrição do relacionamento/fornecedor (string, opcional)
- contextTypes: Lista de tipos de contexto de negócio para este relacionamento (object[], opcional)
- dataTypes: Lista de tipos de dados tratados neste relacionamento (object[], opcional)
- tags: Lista de tags para categorizar este relacionamento (string[], opcional)
- thirdPartyContact: Dados de contato do representante do fornecedor terceirizado (object, opcional)
Retorna os detalhes do relacionamento criado.
create_relationship_by_domain - Criar um novo relacionamento usando apenas o domínio do fornecedor
- domain: Domínio do fornecedor, por exemplo,
visotrust.com(string, obrigatório) - vendorName: Nome do fornecedor (string, obrigatório)
- product: Produto oferecido pelo fornecedor (string, opcional)
- description: Descrição do relacionamento com o fornecedor (string, opcional)
Retorna os detalhes do relacionamento criado.
update_relationship - Atualizar um relacionamento existente com um fornecedor terceirizado
- id: ID do relacionamento (number, obrigatório)
- name: Nome do relacionamento/fornecedor (string, obrigatório)
- homepage: URL da página inicial do fornecedor (string, opcional)
- description: Descrição do relacionamento/fornecedor (string, opcional)
- contextTypes: Lista de tipos de contexto de negócios (object[], opcional)
- dataTypes: Lista de tipos de dados tratados neste relacionamento (object[], opcional)
- businessOwnerEmail: Endereço de e-mail do responsável pelo negócio (string, opcional)
- businessOwnerFirstName: Nome do responsável pelo negócio (string, opcional)
- businessOwnerLastName: Sobrenome do responsável pelo negócio (string, opcional)
- tags: Lista de tags (string[], opcional)
Retorna os detalhes atualizados do relacionamento.
partially_update_relationship - Atualizar parcialmente um relacionamento existente
Aceita os mesmos campos que update_relationship. Somente os campos fornecidos na solicitação são alterados; os demais permanecem inalterados.
Retorna os detalhes atualizados do relacionamento.
search_relationships - Pesquisar relacionamentos por critérios de filtro
Chama POST /api/v1/relationships/search. Todos os filtros são opcionais; os filtros são combinados com AND, e os valores dentro de um mesmo filtro de lista são combinados com OR.
- request: Filtros de pesquisa (object, opcional)
- tags: Nomes das tags, exatamente como aparecem em VISO TRUST (string[], opcional)
- domains: Nomes de domínio dos fornecedores, por exemplo,
example.com(string[], opcional) - name: Nome exato do relacionamento (string, opcional)
- externalId: ID externo exato (string, opcional)
- statuses: Status dos relacionamentos —
NOT_ONBOARDED,ONBOARDED,ARCHIVED(string[], opcional) - assessmentStatuses: Status das avaliações mais recentes (string[], opcional)
- riskAcceptanceStatuses:
RISK_ACCEPTED,REVIEW_NEEDED,REMEDIATION_REQUESTED(string[], opcional) - inherentRiskLevels / residualRiskLevels:
NO_CONTEXT,LOW,MEDIUM,HIGH,EXTREME(string[], opcional) - minScore / maxScore: Intervalo de pontuação, inclusivo (number, opcional)
- businessUnitIds: IDs das unidades de negócios de
get_all_business_units(number[], opcional) - businessOwnerIds / creatorIds: IDs de usuários de
get_all_users(number[], opcional) - createdAfter / createdBefore, onboardedAfter / onboardedBefore, recertificationAfter / recertificationBefore, assessmentCompletedAfter / assessmentCompletedBefore: Data e hora no formato ISO-8601 (string, opcional)
- page: Número da página baseado em zero (number, opcional, padrão 0)
- size: Tamanho da página (number, opcional, padrão 100, máximo 500)
- sort: Ordenações como
property,asc|desc; propriedadesname,externalId,score,createdDate,onboardedDate,recertificationDate(string[], opcional)
Retorna totalCount, page, size, hasMore e a página de relationships correspondentes.
create_tags - Criar novas tags para categorizar relacionamentos
- tags: Lista de nomes de tags a criar (string[], obrigatório)
Retorna uma lista de todas as tags, incluindo as recém-criadas.
update_third_party_contact - Atualizar os dados de contato de um fornecedor terceirizado
- relationshipId: ID do relacionamento (number, obrigatório)
- email: E-mail de contato (string, obrigatório)
- firstName: Nome do contato (string, obrigatório)
- lastName: Sobrenome do contato (string, obrigatório)
Retorna os detalhes atualizados do relacionamento.
onboard_relationship - Integrar um relacionamento, opcionalmente com um resumo de aprovação e configurações de gerenciamento do ciclo de vida
- id: ID do relacionamento (number, obrigatório)
- approvalSummary: Resumo opcional da aprovação registrado durante a integração (string, opcional)
- lifecycleManagementUpdateRequest: Configurações opcionais de gerenciamento do ciclo de vida (object, opcional)
- artifactUpdateSettings.artifactUpdateType: Tipo de atualização do artefato (string enum)
- recertificationSettings.recertificationType: Tipo de recertificação (string enum)
- recertificationSettings.recertificationDate: Data/hora da próxima recertificação, ISO-8601 com deslocamento (string)
- recertificationSettings.reviewFrequency:
THREE_YEARS,TWO_YEARS,ANNUAL,SEMIANNUALouQUARTERLY(string enum)
Retorna os detalhes do relacionamento integrado.
offboard_relationship - Encerrar um relacionamento
- id: ID do relacionamento (number, obrigatório)
Retorna os detalhes do relacionamento encerrado.
accept_relationship_risk - Aceitar o risco de um relacionamento
- id: ID do relacionamento (number, obrigatório)
- request: (object, opcional)
- riskReviewNote: Nota explicando a decisão (string, opcional)
- inherentRiskOverride / residualRiskOverride:
LOW,MEDIUM,HIGHouEXTREME; informe ambos ou nenhum (string, opcional)
Retorna o relacionamento atualizado.
get_relationship_detections - Obter as detecções encontradas nas evidências de um relacionamento
- id: ID do relacionamento (number, obrigatório)
- detectionTypes:
NORMAL,SUBSERVICE,SHARED_RESPONSIBILITY_MODEL,EXCEPTION,CUEC,SUBPROCESSOR; o padrão inclui todos, excetoNORMAL(string[], opcional) - controlDomainTypes: Tipos de domínio de controle a incluir; o padrão inclui todos (string[], opcional)
- assessmentId: Uma avaliação concluída deste relacionamento ou sua avaliação mais recente em andamento (number, opcional)
- includeQuestionnaireAnswers: Incluir as respostas associadas às detecções de questionários complementares (boolean, opcional)
- afterId: O
nextAfterIdda página anterior (number, opcional) - size: Detecções por página, de 1 a 500 (number, opcional, padrão 100)
Retorna uma página de detecções; continue lendo enquanto nextAfterId não for null.
get_risk_advisories_by_relationship - Obter avisos de risco do fornecedor de um relacionamento
- id: ID do relacionamento (number, obrigatório)
archive_relationship - Arquivar um relacionamento
- id: ID do relacionamento (number, obrigatório)
Retorna os detalhes do relacionamento arquivado.
Webhooks
get_all_webhooks - Obter todos os webhooks
Nenhum parâmetro obrigatório.
Retorna uma lista de todas as configurações de webhook.
get_webhook - Obter uma configuração de webhook por id
- id: ID do webhook (number, obrigatório)
Retorna os detalhes de uma configuração específica de webhook.
create_webhook_configuration - Criar uma configuração de webhook
- request: Parâmetros de criação do webhook (object, obrigatório)
- url: URL do webhook (string, obrigatório)
- secret: Segredo do webhook (string, obrigatório)
- eventTypes: Tipos de eventos que acionam o webhook (string[], obrigatório)
- serviceType: Tipo de serviço do webhook (string, obrigatório)
Retorna a configuração de webhook criada.
update_webhook_configuration - Atualizar uma configuração de webhook
- request: Parâmetros de atualização do webhook (object, obrigatório)
- id: ID do webhook (number, obrigatório)
- url: URL do webhook (string, opcional)
- secret: Segredo do webhook (string, opcional)
- eventTypes: Tipos de eventos que acionam o webhook (string[], opcional)
- serviceType: Tipo de serviço do webhook (string, opcional)
Retorna a configuração de webhook atualizada.
delete_webhook_configuration - Excluir uma configuração de webhook
- id: ID do webhook (number, obrigatório)
Exclui a configuração de webhook especificada.
Relatórios de inteligência
create_bitsight_intelligence_report - Criar um novo relatório de inteligência do BitSight
- request: Parâmetros do relatório do BitSight (object, obrigatório)
- vendorDomain: Nome de domínio principal do fornecedor (string, obrigatório)
- reportDate: Data/hora em que o relatório foi gerado (string ISO 8601, obrigatório)
- link: Link opcional para a interface do provedor (string, opcional)
- guid: GUID do BitSight para a entidade (string, obrigatório)
- customId: Identificador personalizado do BitSight (string, opcional)
- name: Nome de exibição da entidade do BitSight (string, opcional)
- description: Descrição da entidade do BitSight (string, opcional)
- primaryDomain: Domínio principal da entidade do BitSight (string, opcional)
- ratingRange: Faixa de classificação do BitSight (string, opcional)
- ratingColor: Cor da classificação do BitSight (string, opcional)
- confidence: Nível de confiança da classificação do BitSight (string, opcional)
Retorna o relatório de inteligência criado.
create_security_scorecard_intelligence_report - Criar um novo relatório de inteligência do SecurityScorecard
- request: Parâmetros do relatório do SecurityScorecard (object, obrigatório)
- vendorDomain: Nome de domínio principal do fornecedor (string, obrigatório)
- reportDate: Data/hora em que o relatório foi gerado (string ISO 8601, obrigatório)
- link: Link opcional para a interface do provedor (string, opcional)
- grade: Nota em letras do SecurityScorecard (string, obrigatório)
- domain: Domínio associado à entidade do scorecard (string, opcional)
- score: Pontuação numérica do SecurityScorecard (number, opcional)
Retorna o relatório de inteligência criado.
create_recorded_future_intelligence_report - Criar um novo relatório de inteligência do Recorded Future
- request: Parâmetros do relatório do Recorded Future (object, obrigatório)
- vendorDomain: Nome de domínio principal do fornecedor (string, obrigatório)
- reportDate: Data/hora em que o relatório foi gerado (string ISO 8601, obrigatório)
- entityType: Tipo de entidade do Recorded Future, por exemplo,
Company(string, obrigatório) - entity: Identificador da entidade do Recorded Future (string, obrigatório)
- riskScore: Pontuação numérica de risco (number, obrigatório)
- riskLevel: Rótulo do nível de risco, por exemplo,
Critical/High/Medium/Low(string, obrigatório) - link: Link opcional para o relatório na interface do provedor (string, opcional)
- firstSeen: Data mais antiga em que a entidade foi observada, ISO 8601 (string, opcional)
- lastSeen: Data mais recente em que a entidade foi observada, ISO 8601 (string, opcional)
- triggeredRuleCount: Número de regras do Recorded Future acionadas (number, opcional)
- maxRuleCount: Número máximo de regras do Recorded Future avaliadas (number, opcional)
- summary: Texto de resumo opcional do Recorded Future (string, opcional)
- criticalityLabel: Rótulo de criticidade do Recorded Future para a entidade (string, opcional)
Retorna o relatório de inteligência criado.
get_intelligence_reports_by_vendor - Obter todos os relatórios de inteligência de um fornecedor
- vendorDomain: Nome de domínio principal do fornecedor (string, obrigatório)
Retorna uma lista de relatórios de inteligência do fornecedor especificado.
get_intelligence_report - Obter um relatório de inteligência por ID
- id: ID do relatório (UUID, obrigatório)
update_bitsight_intelligence_report, update_security_scorecard_intelligence_report, update_recorded_future_intelligence_report - Substituir um relatório de inteligência existente
- id: ID do relatório (UUID, obrigatório)
- request: Mesmos campos da ferramenta
create_*_intelligence_reportcorrespondente. Os campos opcionais omitidos são apagados.
delete_intelligence_report - Excluir permanentemente um relatório de inteligência
- id: ID do relatório (UUID, obrigatório)
bulk_create_bitsight_intelligence_reports, bulk_create_security_scorecard_intelligence_reports, bulk_create_recorded_future_intelligence_reports - Criar até 1000 relatórios de inteligência de uma só vez
- reports: Mesmos campos da ferramenta
create_*_intelligence_reportcorrespondente (object[], obrigatório)
Retorna totalCount, os IDs dos relatórios created e backgroundedCount para os relatórios enfileirados para criação em segundo plano.
get_latest_intelligence_report - Obter o relatório de inteligência mais recente de um fornecedor de uma fonte específica
- vendorDomain: Nome de domínio principal do fornecedor (string, obrigatório)
- source: Provedor de inteligência (string enum:
BITSIGHT,SECURITY_SCORECARDouRECORDED_FUTURE, obrigatório)
Retorna o relatório de inteligência mais recente do fornecedor e da fonte especificados.
Avisos de risco
get_risk_advisories_by_vendor - Obter todos os avisos de risco de um fornecedor
- vendorId: ID do fornecedor (number, obrigatório)
Retorna avisos de segurança, conformidade, vulnerabilidade, jurídicos, geopolíticos, financeiros e operacionais publicados para o fornecedor.
Usuários
get_all_users - Obter todos os usuários da sua organização
- page: Página de resultados a recuperar (número, opcional; padrão 0)
- size: Número de registros por página (número, opcional; padrão 20)
- sort: Critério de ordenação no formato: propriedade(,asc|desc) (string, opcional)
Retorna uma lista paginada de usuários.
get_user_by_email - Obter um usuário por e-mail
- email: Endereço de e-mail do usuário (string, obrigatório)
Retorna os detalhes do usuário.
create_user - Criar um novo usuário
- request: Parâmetros de criação do usuário (objeto, obrigatório)
- email: Endereço de e-mail do novo usuário (string, obrigatório)
- firstName: Nome do novo usuário (string, obrigatório)
- lastName: Sobrenome do novo usuário (string, obrigatório)
Retorna o usuário criado.
Formatação de código
Este projeto usa Spotless com Google Java Format para formatar o código. Um hook de pré-commit é configurado automaticamente para garantir um estilo de código consistente.
Configuração
Após clonar o repositório, o hook de pré-commit será configurado automaticamente quando você executar qualquer comando do Gradle.
Formatação manual
Para formatar manualmente todos os arquivos:
./gradlew spotlessApply
Para verificar se os arquivos estão formatados corretamente:
./gradlew spotlessCheck
Se o hook de pré-commit rejeitar seu commit devido a problemas de formatação, basta executar ./gradlew spotlessApply para corrigir a formatação e tentar fazer o commit novamente.
Licença
Este projeto está licenciado sob a Licença MIT — consulte o arquivo LICENSE para obter detalhes.