ANPD SEI Integrations
    Preparing search index...

    Class SipReplicacaoClientExperimental

    Operações que alteram estado no SIP.

    Os nomes evitam expor diretamente detalhes obscuros do WSDL para o restante do SGI. A tradução para StaOperacao, SinSubunidades e arrays SOAP fica concentrada aqui.

    Estas operações requerem que o sistema consumidor tenha os serviços de replicação liberados explicitamente no SIP. Não solicite essas permissões para integrações somente leitura.

    replicarUsuarios com operacao: "C", "A" ou "D" está confirmado funcionando contra um ambiente SIP real (uso contínuo em produção pelo SGI). operacao: "R" (reativar) tem um caso confirmado em produção (17/09/2026) em que o SIP retornou sucesso sem aplicar a reativação — ver o @remarks de SipOperacaoReplicacaoUsuario antes de depender do retorno de "R" como confirmação. replicarPermissoes e validarReplicacao continuam sem validação de ponta a ponta confirmada — a suíte de smoke test do repositório cobre apenas as consultas (SipConsultasClient). Valide essas duas em homologação antes de usar em produção.

    Em aplicações que usam SipClient, acesse esta classe via sipClient.replicacao.

    import { SipReplicacaoClient } from "@anpdgovbr/sip-client"

    const replicacao = new SipReplicacaoClient(config)
    const ok = await replicacao.replicarUsuarios([{
      operacao: "C",
      idOrigem: "ad:joao.silva",
      idOrgao: "0",
      sigla: "joao.silva",
      nome: "João Silva",
    }])
    Index
    constructor
    replicarPermissoes replicarUsuarios validarReplicacao
    • Experimental

      Replica um lote de permissões no SIP (cadastra/altera ou exclui).

      Parameters

      • permissoes: readonly Readonly<
            {
                dataFinal?: string
                | null;
                dataInicial: string;
                idOrgaoUnidade?: string | null;
                idOrgaoUsuario?: string | null;
                idOrigemUnidade?: string | null;
                idOrigemUsuario?: string | null;
                idPerfil: string;
                idSistema?: string | null;
                idUnidade?: string | null;
                idUsuario?: string | null;
                operacao: SipOperacaoReplicacaoPermissao;
                sinSubunidades: boolean;
            },
        >[]

        Lista de permissões com a operação desejada.

      Returns Promise<boolean>

      true se o SIP confirmou a operação com sucesso.

      Quando idSistema é omitido em uma entrada de SipReplicarPermissao, o cliente substitui pelo systemId da configuração.

      SipSoapError em caso de falha de comunicação, SOAP Fault ou rejeição pelo SIP.

      await replicacao.replicarPermissoes([{
        operacao: "A",
        idUsuario: "100000103",
        idUnidade: "110000075",
        idPerfil: "100000940",
        dataInicial: "01/01/2026",
        sinSubunidades: false,
      }])
    • Experimental

      Replica um lote de usuários no SIP (cria, altera, exclui, desativa ou reativa).

      Parameters

      • usuarios: readonly Readonly<
            {
                cpf?: string
                | null;
                email?: string | null;
                idOrgao: string;
                idOrigem: string;
                nome: string;
                nomeSocial?: string | null;
                operacao: SipOperacaoReplicacaoUsuario;
                sigla: string;
            },
        >[]

        Lista de usuários com a operação desejada para cada um.

      Returns Promise<boolean>

      true se o SIP confirmou a operação com sucesso.

      SipSoapError em caso de falha de comunicação, SOAP Fault ou rejeição pelo SIP.

      true para operacao: "R" confirma apenas que o SIP aceitou a chamada - não que o usuário foi de fato reativado. Nessa operação, o contrato oficial informa que somente IdOrigem é considerado; campos como cpf podem ser ignorados. Ver o @remarks de SipOperacaoReplicacaoUsuario. Para "C", "A" e "D" o retorno reflete a aplicação real, confirmado em produção.

      await replicacao.replicarUsuarios([
        { operacao: "C", idOrigem: "ad:novo.usuario", idOrgao: "0",
          sigla: "novo.usuario", nome: "Novo Usuário" },
        { operacao: "D", idOrigem: "ad:antigo.usuario", idOrgao: "0",
          sigla: "antigo.usuario", nome: "Antigo Usuário" },
      ])
    • Experimental

      Valida se uma replicação agendada foi concluída com sucesso no SIP.

      Parameters

      • idReplicacao: string

        Identificador da replicação a ser validada.

      Returns Promise<boolean>

      true se a replicação foi processada com sucesso.

      O SIP pode processar replicações de forma assíncrona. Este método permite verificar o status de uma replicação pelo seu identificador.

      SipSoapError em caso de falha de comunicação ou SOAP Fault.

    Settings
    Member Visibility

    On This Page
    Constructors
    Methods