Class SipConsultasClient

Operações somente leitura do SIP.

Esta classe não conhece framework, banco, cache, auditoria ou UI. Ela é deliberadamente fina: recebe config, chama SOAP e devolve tipos TypeScript. Isso mantém o pacote portável entre aplicações.

Remarks

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

Example

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

const consultas = new SipConsultasClient({
  endpointUrl: "https://sei.orgao.gov.br/sip/ws/SipWS.php",
  accessKey: "minha-chave",
  systemId: "100000100",
  requestTimeoutMs: 30_000,
})

const orgaos = await consultas.listarOrgaos()

See

Index

Constructors

constructor

Methods

buscarUsuarioComPermissoesPorSigla buscarUsuarioPorSigla buscarUsuarios buscarUsuariosSemPermissao carregarUsuario listarOrgaos listarPerfis listarPermissoes listarRecursos listarUnidades pesquisarUsuario

Constructors

constructor

new SipConsultasClient(config: SipConfig): SipConsultasClient
Parameters
- config: SipConfig
  Configuração de conexão com o SIP.
Returns SipConsultasClient
- Defined in packages/sip-client/src/client.ts:156

Methods

buscarUsuarioComPermissoesPorSigla

buscarUsuarioComPermissoesPorSigla(
    siglaUsuario: string,
): Promise<
    | Readonly<
        {
            permissoes: Readonly<
                {
                    dataFinal: string
                    | null;
                    dataInicial: string;
                    idOrgaoUnidade: string | null;
                    idOrgaoUsuario: string | null;
                    idOrigemUnidade: string | null;
                    idOrigemUsuario: string | null;
                    idPerfil: string;
                    idSistema: string;
                    idUnidade: string;
                    idUsuario: string;
                    sinSubunidades: boolean;
                },
            >[];
            usuario: SipUsuario;
        },
    >
    | null,
>
Helper composto que busca um usuário pela sigla e suas permissões em uma única chamada de alto nível (duas requisições ao SIP).
Parameters
- siglaUsuario: string
  Login exato do usuário no SIP.
Returns Promise<
    | Readonly<
        {
            permissoes: Readonly<
                {
                    dataFinal: string
                    | null;
                    dataInicial: string;
                    idOrgaoUnidade: string | null;
                    idOrgaoUsuario: string | null;
                    idOrigemUnidade: string | null;
                    idOrigemUsuario: string | null;
                    idPerfil: string;
                    idSistema: string;
                    idUnidade: string;
                    idUsuario: string;
                    sinSubunidades: boolean;
                },
            >[];
            usuario: SipUsuario;
        },
    >
    | null,
>
Objeto com usuario e permissoes, ou null se o usuário não existir.
Throws
SipSoapError em caso de falha em qualquer uma das duas requisições.
Example
```
const resultado = await consultas.buscarUsuarioComPermissoesPorSigla("joao.silva")
if (resultado) {
  const { usuario, permissoes } = resultado
  console.log(usuario.nome, permissoes.length)
}
```
- Defined in packages/sip-client/src/client.ts:445

buscarUsuarioPorSigla

buscarUsuarioPorSigla(
    siglaUsuario: string,
): Promise<
    | Readonly<
        {
            ativo: boolean;
            cpf: string
            | null;
            email: string | null;
            id: string;
            idOrgao: string | null;
            idOrigem: string | null;
            nome: string;
            nomeSocial: string | null;
            sigla: string;
            unidades: string[];
        },
    >
    | null,
>
Retorna o primeiro usuário encontrado pela sigla (login), ou null.
Parameters
- siglaUsuario: string
  Login exato do usuário no SIP.
Returns Promise<
    | Readonly<
        {
            ativo: boolean;
            cpf: string
            | null;
            email: string | null;
            id: string;
            idOrgao: string | null;
            idOrigem: string | null;
            nome: string;
            nomeSocial: string | null;
            sigla: string;
            unidades: string[];
        },
    >
    | null,
>
O usuário encontrado, ou null se não existir.
Remarks
Conveniente para lookups pontuais. Para obter também as permissões, use buscarUsuarioComPermissoesPorSigla.

Throws
SipSoapError em caso de falha de comunicação ou SOAP Fault.
Example
```
const usuario = await consultas.buscarUsuarioPorSigla("joao.silva")
if (usuario) console.log(usuario.nome)
```
- Defined in packages/sip-client/src/client.ts:252

buscarUsuarios

buscarUsuarios(
    params: SipBuscarUsuariosParams,
): Promise<
    Readonly<
        {
            ativo: boolean;
            cpf: string
            | null;
            email: string | null;
            id: string;
            idOrgao: string | null;
            idOrigem: string | null;
            nome: string;
            nomeSocial: string | null;
            sigla: string;
            unidades: string[];
        },
    >[],
>
Busca usuários cadastrados no SIP com base em filtros combinativos.
Parameters
- params: SipBuscarUsuariosParams
  Pelo menos um filtro é recomendado para evitar retornos excessivamente grandes.
Returns Promise<
    Readonly<
        {
            ativo: boolean;
            cpf: string
            | null;
            email: string | null;
            id: string;
            idOrgao: string | null;
            idOrigem: string | null;
            nome: string;
            nomeSocial: string | null;
            sigla: string;
            unidades: string[];
        },
    >[],
>
Lista de usuários que atendem a todos os filtros informados.
Throws
SipSoapError em caso de falha de comunicação ou SOAP Fault.
Example
```
const usuarios = await consultas.buscarUsuarios({ idUnidade: "110000075" })
```
- Defined in packages/sip-client/src/client.ts:218

buscarUsuariosSemPermissao

buscarUsuariosSemPermissao(
    params?: SipBuscarUsuariosSemPermissaoParams,
): Promise<
    Readonly<
        {
            ativo: boolean;
            cpf: string
            | null;
            email: string | null;
            id: string;
            idOrgao: string | null;
            idOrigem: string | null;
            nome: string;
            nomeSocial: string | null;
            sigla: string;
            unidades: string[];
        },
    >[],
>
Lista usuários cadastrados no SIP que não possuem nenhuma permissão no sistema configurado.

Útil para auditorias de acesso e limpeza de contas obsoletas.
Parameters
- params: SipBuscarUsuariosSemPermissaoParams = {}
  Filtros opcionais.
Returns Promise<
    Readonly<
        {
            ativo: boolean;
            cpf: string
            | null;
            email: string | null;
            id: string;
            idOrgao: string | null;
            idOrigem: string | null;
            nome: string;
            nomeSocial: string | null;
            sigla: string;
            unidades: string[];
        },
    >[],
>
Lista de usuários sem permissão.

Throws
SipSoapError em caso de falha de comunicação ou SOAP Fault.
- Defined in packages/sip-client/src/client.ts:267

carregarUsuario

carregarUsuario(
    params: SipCarregarUsuarioParams,
): Promise<
    | Readonly<
        {
            cpf: string
            | null;
            email: string | null;
            idOrgao: string | null;
            nome: string;
            nomeSocial: string | null;
            sigla: string;
        },
    >
    | null,
>
Carrega os dados de um usuário diretamente do servidor de autenticação configurado no SIP para o órgão informado.
Parameters
- params: SipCarregarUsuarioParams
  Tipo do servidor de autenticação, órgão e sigla.
Returns Promise<
    | Readonly<
        {
            cpf: string
            | null;
            email: string | null;
            idOrgao: string | null;
            nome: string;
            nomeSocial: string | null;
            sigla: string;
        },
    >
    | null,
>
Dados do usuário no diretório, ou null se não encontrado.

Remarks
Diferente de buscarUsuarios, esta operação consulta o diretório externo (ex.: LDAP/AD) e não o banco interno do SIP. O resultado não incluí id, ativo nem unidades.

Throws
SipSoapError em caso de falha de comunicação ou SOAP Fault.
- Defined in packages/sip-client/src/client.ts:296

listarOrgaos

listarOrgaos(
    params?: SipListarOrgaosParams,
): Promise<
    Readonly<
        { ativo: boolean; descricao: string; id: string; sigla: string },
    >[],
>
Lista os órgãos cadastrados no SIP.
Parameters
- params: SipListarOrgaosParams = {}
  Filtros opcionais. Passe { todos: false } para retornar apenas órgãos ativos.
Returns Promise<
    Readonly<
        { ativo: boolean; descricao: string; id: string; sigla: string },
    >[],
>
Lista de órgãos.
Throws
SipSoapError em caso de falha de comunicação ou SOAP Fault.
Example
```
const ativos = await consultas.listarOrgaos({ todos: false })
```
- Defined in packages/sip-client/src/client.ts:170

listarPerfis

listarPerfis(
    params?: SipListarPerfisParams,
): Promise<
    Readonly<
        {
            ativo: boolean;
            descricao: string
            | null;
            grupos: Readonly<{ ativo: boolean; id: string; nome: string }>[];
            id: string;
            menus: Readonly<
                {
                    ativo: boolean;
                    id: string;
                    itens: Readonly<
                        {
                            ativo: boolean;
                            id: string;
                            idRecurso: (...)
                            | (...);
                            ramificacao: (...) | (...);
                            rotulo: string;
                        },
                    >[];
                    nome: string;
                },
            >[];
            nome: string;
            recursos: Readonly<
                {
                    ativo: boolean;
                    descricao: string
                    | null;
                    id: string;
                    nome: string;
                },
            >[];
        },
    >[],
>
Lista os perfis cadastrados no SIP para o sistema configurado.
Parameters
- params: SipListarPerfisParams = {}
  Filtros e controle de profundidade da resposta. Use filtroRecursosMenus: "T" para incluir recursos e menus.
Returns Promise<
    Readonly<
        {
            ativo: boolean;
            descricao: string
            | null;
            grupos: Readonly<{ ativo: boolean; id: string; nome: string }>[];
            id: string;
            menus: Readonly<
                {
                    ativo: boolean;
                    id: string;
                    itens: Readonly<
                        {
                            ativo: boolean;
                            id: string;
                            idRecurso: (...)
                            | (...);
                            ramificacao: (...) | (...);
                            rotulo: string;
                        },
                    >[];
                    nome: string;
                },
            >[];
            nome: string;
            recursos: Readonly<
                {
                    ativo: boolean;
                    descricao: string
                    | null;
                    id: string;
                    nome: string;
                },
            >[];
        },
    >[],
>
Lista de perfis.
Throws
SipSoapError em caso de falha de comunicação ou SOAP Fault.
Example
```
// Inclui recursos e menus de cada perfil
const perfis = await consultas.listarPerfis({ filtroRecursosMenus: "T" })
```
- Defined in packages/sip-client/src/client.ts:348

listarPermissoes

listarPermissoes(
    params?: SipListarPermissoesParams,
): Promise<
    Readonly<
        {
            dataFinal: string
            | null;
            dataInicial: string;
            idOrgaoUnidade: string | null;
            idOrgaoUsuario: string | null;
            idOrigemUnidade: string | null;
            idOrigemUsuario: string | null;
            idPerfil: string;
            idSistema: string;
            idUnidade: string;
            idUsuario: string;
            sinSubunidades: boolean;
        },
    >[],
>
Lista as permissões ativas no sistema configurado, com filtros opcionais.
Parameters
- params: SipListarPermissoesParams = {}
  Filtros combinativos opcionais.
Returns Promise<
    Readonly<
        {
            dataFinal: string
            | null;
            dataInicial: string;
            idOrgaoUnidade: string | null;
            idOrgaoUsuario: string | null;
            idOrigemUnidade: string | null;
            idOrigemUsuario: string | null;
            idPerfil: string;
            idSistema: string;
            idUnidade: string;
            idUsuario: string;
            sinSubunidades: boolean;
        },
    >[],
>
Lista de permissões.
Remarks
Omitir todos os filtros retorna todas as permissões do sistema. Use com cautela em sistemas com muitos usuários.

Throws
SipSoapError em caso de falha de comunicação ou SOAP Fault.
Example
```
const permissoes = await consultas.listarPermissoes({ idUsuario: "100000103" })
```
- Defined in packages/sip-client/src/client.ts:407

listarRecursos

listarRecursos(params?: SipListarRecursosParams): Promise<string[]>
Lista os recursos (permissões atômicas) do sistema configurado.
Parameters
- params: SipListarRecursosParams = {}
  Filtros opcionais por perfil ou nome de recurso.
Returns Promise<string[]>
Lista de nomes de recursos (ex.: ["documento_gerar", "processo_consultar"]).
Throws
SipSoapError em caso de falha de comunicação ou SOAP Fault.
Example
```
// Somente recursos do perfil 100000940
const recursos = await consultas.listarRecursos({ perfis: ["100000940"] })
```
- Defined in packages/sip-client/src/client.ts:378

listarUnidades

listarUnidades(
    params?: SipListarUnidadesParams,
): Promise<
    Readonly<
        {
            ativo: boolean;
            descricao: string;
            id: string;
            idOrgao: string
            | null;
            idOrigem: string | null;
            sigla: string;
            subunidades: string[];
            unidadesSuperiores: string[];
        },
    >[],
>
Lista as unidades organizacionais visíveis pelo sistema configurado.
Parameters
- params: SipListarUnidadesParams = {}
  Filtros opcionais. Aceita idUsuario para filtrar por usuário ou idUnidade para uma unidade específica.
Returns Promise<
    Readonly<
        {
            ativo: boolean;
            descricao: string;
            id: string;
            idOrgao: string
            | null;
            idOrigem: string | null;
            sigla: string;
            subunidades: string[];
            unidadesSuperiores: string[];
        },
    >[],
>
Lista de unidades.
Throws
SipSoapError em caso de falha de comunicação ou SOAP Fault.
Example
```
const unidades = await consultas.listarUnidades({ idUsuario: "100000103" })
```
- Defined in packages/sip-client/src/client.ts:193

pesquisarUsuario

pesquisarUsuario(
    params: SipPesquisarUsuarioParams,
): Promise<
    | Readonly<
        {
            cpf: string
            | null;
            email: string | null;
            idOrgao: string | null;
            nome: string;
            nomeSocial: string | null;
            sigla: string;
        },
    >
    | null,
>
Pesquisa um usuário no diretório externo sem filtrar pelo sistema configurado.
Parameters
- params: SipPesquisarUsuarioParams
  Tipo do servidor de autenticação, órgão e sigla.
Returns Promise<
    | Readonly<
        {
            cpf: string
            | null;
            email: string | null;
            idOrgao: string | null;
            nome: string;
            nomeSocial: string | null;
            sigla: string;
        },
    >
    | null,
>
Dados do usuário no diretório, ou null se não encontrado.

Remarks
Semelhante a carregarUsuario, mas usa os campos idOrgao e sigla (sem sufixo Usuario), conforme a operação pesquisarUsuario do WSDL.

Throws
SipSoapError em caso de falha de comunicação ou SOAP Fault.
- Defined in packages/sip-client/src/client.ts:322

Class SipConsultasClient

Remarks

Example

See

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SipConsultasClient

Methods

buscarUsuarioComPermissoesPorSigla

Parameters

Throws

Example

buscarUsuarioPorSigla

Parameters

Returns Promise< | Readonly< { ativo: boolean; cpf: string | null; email: string | null; id: string; idOrgao: string | null; idOrigem: string | null; nome: string; nomeSocial: string | null; sigla: string; unidades: string[]; }, > | null,>

Remarks

Throws

Example

buscarUsuarios

Parameters

Returns Promise< Readonly< { ativo: boolean; cpf: string | null; email: string | null; id: string; idOrgao: string | null; idOrigem: string | null; nome: string; nomeSocial: string | null; sigla: string; unidades: string[]; }, >[],>

Throws

Example

buscarUsuariosSemPermissao

Parameters

Returns Promise< Readonly< { ativo: boolean; cpf: string | null; email: string | null; id: string; idOrgao: string | null; idOrigem: string | null; nome: string; nomeSocial: string | null; sigla: string; unidades: string[]; }, >[],>

Throws

carregarUsuario

Parameters

Returns Promise< | Readonly< { cpf: string | null; email: string | null; idOrgao: string | null; nome: string; nomeSocial: string | null; sigla: string; }, > | null,>

Remarks

Throws

listarOrgaos

Parameters

Returns Promise< Readonly< { ativo: boolean; descricao: string; id: string; sigla: string }, >[],>

Throws

Example

listarPerfis

Parameters

Throws

Example

listarPermissoes

Parameters

Remarks

Throws

Example

listarRecursos

Parameters

Returns Promise<string[]>

Throws

Example

listarUnidades

Parameters

Returns Promise< Readonly< { ativo: boolean; descricao: string; id: string; idOrgao: string | null; idOrigem: string | null; sigla: string; subunidades: string[]; unidadesSuperiores: string[]; }, >[],>

Throws

Example

pesquisarUsuario

Parameters

Returns Promise< | Readonly< { cpf: string | null; email: string | null; idOrgao: string | null; nome: string; nomeSocial: string | null; sigla: string; }, > | null,>

Remarks

Throws

Settings

On This Page

Returns Promise<
| Readonly<
{
ativo: boolean;
cpf: string
| null;
email: string | null;
id: string;
idOrgao: string | null;
idOrigem: string | null;
nome: string;
nomeSocial: string | null;
sigla: string;
unidades: string[];
},
>
| null,
>

Returns Promise<
Readonly<
{
ativo: boolean;
cpf: string
| null;
email: string | null;
id: string;
idOrgao: string | null;
idOrigem: string | null;
nome: string;
nomeSocial: string | null;
sigla: string;
unidades: string[];
},
>[],
>

Returns Promise<
Readonly<
{
ativo: boolean;
cpf: string
| null;
email: string | null;
id: string;
idOrgao: string | null;
idOrigem: string | null;
nome: string;
nomeSocial: string | null;
sigla: string;
unidades: string[];
},
>[],
>

Returns Promise<
| Readonly<
{
cpf: string
| null;
email: string | null;
idOrgao: string | null;
nome: string;
nomeSocial: string | null;
sigla: string;
},
>
| null,
>

Returns Promise<
Readonly<
{ ativo: boolean; descricao: string; id: string; sigla: string },
>[],
>

Returns Promise<
Readonly<
{
ativo: boolean;
descricao: string;
id: string;
idOrgao: string
| null;
idOrigem: string | null;
sigla: string;
subunidades: string[];
unidadesSuperiores: string[];
},
>[],
>

Returns Promise<
| Readonly<
{
cpf: string
| null;
email: string | null;
idOrgao: string | null;
nome: string;
nomeSocial: string | null;
sigla: string;
},
>
| null,
>