Pesquisar usuários

Versão 4.0.23.6 (mais recente)

Pesquisar usuários

Retorna todos* registros de usuários que correspondem aos critérios de pesquisa fornecidos.

Se vários parâmetros de pesquisa forem fornecidos e filter_or for FALSE ou não for especificado, eles serão combinados em uma operação lógica AND. Somente as linhas que correspondem a todos os critérios de parâmetro de pesquisa serão retornadas.

Se filter_or for TRUE, vários parâmetros de pesquisa serão combinados em uma operação lógica OR. Os resultados incluirão linhas que correspondem a qualquer um dos critérios de pesquisa.

Os parâmetros de pesquisa da string usam correspondência indiferente a maiúsculas. Os parâmetros de pesquisa de string podem conter % e '_' como SQL COMO o padrão de correspondência de expressões de caractere curinga. example="dan%" corresponderá a "danger" e "Danzig", mas não a "David" example="D_m%" corresponderá a "Dageage" e "dump"

Parâmetros de pesquisa de número inteiro podem aceitar um único valor ou uma lista de valores separados por vírgulas. Os vários valores serão combinados em uma operação lógica de OR. Os resultados corresponderão a pelo menos um dos valores fornecidos.

A maioria dos parâmetros de pesquisa pode aceitar "IS NULL" e "NOT NULL" como expressões especiais para corresponder ou excluir (respectivamente) linhas em que a coluna é nula.

Os parâmetros de pesquisa booleana só aceitam valores "verdadeiro" e "falso".

(*) Os resultados são sempre filtrados com o nível de informações que o autor da chamada tem permissão para ver. Os administradores do Looker podem ver todos os detalhes do usuário. Usuários normais de um sistema aberto podem ver nomes de outros usuários, mas nenhum detalhe. Usuários normais de um sistema fechado só podem ver nomes de outros usuários que são membros do mesmo grupo do usuário.

Solicitação

GET /users/search
Tipo de dados
Descrição
Solicitação
HTTPRequest
consulta
Consulta HTTP
Expandir a definição de HTTPQuery...
campos
string
Incluir apenas estes campos na resposta
page
integer
OBSOLETO. Use limit e offset. Retornar apenas a página N de resultados paginados
por_página
integer
OBSOLETO. Use limit e offset. Retornar N linhas de dados por página
limite
integer
Número de resultados a serem retornados. (usado com deslocamento e tem prioridade sobre página e por página)
offset
integer
Número de resultados a pular antes de retornar qualquer um. (usado com limite e tem prioridade sobre página e por página)
classificações
string
Campos para classificação.
id
string
Corresponder ao User ID.
first_name
string
Corresponde ao nome.
last_name
string
Corresponde ao sobrenome.
verificado_funcionário_funcionário
booleano
Pesquisar contas de usuário associadas a funcionários do Looker
incorporar_usuário
booleano
Pesquisar apenas usuários incorporados
e-mail
string
Pesquise o usuário com este endereço de e-mail
is_disabled
booleano
Pesquisar contas de usuário desativadas
filtro_ou
booleano
Combinar determinados critérios de pesquisa em uma expressão booleana OR
Content_metadata_id
string
Pesquisar usuários que têm acesso a este item content_metadata
group_id
string
Pesquisar usuários que são participantes diretos deste grupo

Resposta

200: usuários correspondentes.

Tipo de dados
Descrição
(matriz)
pode
objeto
Operações que o usuário atual pode realizar neste objeto
URL_do_ avatar
string
URL da imagem de avatar (pode ser genérico)
avatar_url_sem_dimensionamento
string
URL da imagem de avatar (pode ser genérico), não especifica o tamanho
credentials_api3
Expandir a definição de CredentialsApi3...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
id
string
ID exclusivo
client_id
string
client_id da chave de API
criado_em
string
Carimbo de data/hora para a criação dessa credencial
is_disabled
booleano
Esta credencial foi desativada?
tipo
string
Nome curto do tipo desse tipo de credencial
url
string
Link para obter este item
credenciais_e-mail
CredentialsEmail (em inglês)
Credenciais de login de e-mail/senha
Expandir definição de CredentialsEmail...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
criado_em
string
Carimbo de data/hora para a criação dessa credencial
e-mail
string
Endereço de e-mail usado para o login do usuário
force_password_reset_at_next_login
booleano
Forçar o usuário a alterar a senha no próximo login
user_id
string
ID exclusivo do usuário
is_disabled
booleano
Esta credencial foi desativada?
conectado_em_
string
Carimbo de data/hora do login mais recente usando a credencial
password_reset_url
string
URL com token de uso único que o usuário pode usar para redefinir senha
URL_de_configuração_da_conta
string
URL com token secreto de uso único que o usuário pode usar para configurar a conta
tipo
string
Nome curto do tipo desse tipo de credencial
url
string
Link para obter este item
URL_usuário
string
Link para acessar este usuário
credencial_embed
Expandir definição de CredentialsEmbed...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
criado_em
string
Carimbo de data/hora para a criação dessa credencial
ID_grupo_externo
string
ID do incorporador de um grupo ao qual este usuário foi adicionado durante o login mais recente
ID_usuário_externo
string
Código exclusivo do incorporador para o usuário
id
string
ID exclusivo
is_disabled
booleano
Esta credencial foi desativada?
conectado_em_
string
Carimbo de data/hora do login mais recente usando a credencial
tipo
string
Nome curto do tipo desse tipo de credencial
url
string
Link para obter este item
credenciais_google
Credenciais de autenticação do Google
Expandir a definição do CredentialsGoogle...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
criado_em
string
Carimbo de data/hora para a criação dessa credencial
domínio
string
Domínio do Google
e-mail
string
Endereço de e-mail
ID do usuário do Google
string
ID exclusivo do Google para este usuário
is_disabled
booleano
Esta credencial foi desativada?
conectado_em_
string
Carimbo de data/hora do login mais recente usando a credencial
tipo
string
Nome curto do tipo desse tipo de credencial
url
string
Link para obter este item
credenciais_ldap
CredentialsLDAP (em inglês)
Credenciais LDAP
Expandir a definição do CredentialsLDAP...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
criado_em
string
Carimbo de data/hora para a criação dessa credencial
e-mail
string
Endereço de e-mail
is_disabled
booleano
Esta credencial foi desativada?
LDAP_dn
string
Nome distinto do LDAP deste usuário (a partir do último login)
ID_ldap
string
ID exclusivo LDAP deste usuário
conectado_em_
string
Carimbo de data/hora do login mais recente usando a credencial
tipo
string
Nome curto do tipo desse tipo de credencial
url
string
Link para obter este item
credenciais_looker_openid
Credenciais do LookerOpenID. Usado para login pelos analistas do Looker
Expandir a definição do CredentialsLookerOpenid...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
criado_em
string
Carimbo de data/hora para a criação dessa credencial
e-mail
string
Endereço de e-mail usado para o login do usuário
is_disabled
booleano
Esta credencial foi desativada?
conectado_em_
string
Carimbo de data/hora do login mais recente usando a credencial
conectado_ip
string
Endereço IP do cliente para login mais recente usando a credencial
tipo
string
Nome curto do tipo desse tipo de credencial
url
string
Link para obter este item
URL_usuário
string
Link para acessar este usuário
credentials_oidc
Credenciais de autenticação do OpenID Connect
Expandir a definição do CredentialsOIDC...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
criado_em
string
Carimbo de data/hora para a criação dessa credencial
e-mail
string
Endereço de e-mail
is_disabled
booleano
Esta credencial foi desativada?
conectado_em_
string
Carimbo de data/hora do login mais recente usando a credencial
oidc_user_id
string
Código exclusivo do OP do OIDC para esse usuário
tipo
string
Nome curto do tipo desse tipo de credencial
url
string
Link para obter este item
credenciais_saml
CredentialsSaml (em inglês)
Credenciais de autenticação do Saml
Expandir a definição do CredentialsSaml...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
criado_em
string
Carimbo de data/hora para a criação dessa credencial
e-mail
string
Endereço de e-mail
is_disabled
booleano
Esta credencial foi desativada?
conectado_em_
string
Carimbo de data/hora do login mais recente usando a credencial
saml_user_id
string
ID exclusivo do IdP do Saml para este usuário
tipo
string
Nome curto do tipo desse tipo de credencial
url
string
Link para obter este item
credenciais_totp
CredentialsTotp (em inglês)
Credenciais de dois fatores
Expandir a definição de CredentialsTotp...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
criado_em
string
Carimbo de data/hora para a criação dessa credencial
is_disabled
booleano
Esta credencial foi desativada?
tipo
string
Nome curto do tipo desse tipo de credencial
verificado
booleano
O usuário verificou
url
string
Link para obter este item
display_name
string
Nome completo para exibição (disponível apenas se first_name e last_name estiverem definidos)
e-mail
string
Endereço de e-mail
código_do_espaço_de_grupo_incorporado
string
(OBSOLETO) (Incorporado apenas) ID do espaço do grupo do usuário com base no external_group_id especificado opcionalmente durante o login do usuário incorporado
first_name
string
Nome
IDs_do_grupo
string[]
ID_da_pasta_inicial
string
String de ID da pasta inicial do usuário
id
string
ID exclusivo
is_disabled
booleano
A conta foi desativada
last_name
string
Sobrenome
locale
string
O local de preferência do usuário. A localidade do usuário tem prioridade sobre a localidade padrão do Looker em todo o sistema. A localidade determina o idioma das strings de exibição e a formatação numérica e de data nas respostas da API. A string de localidade deve ser um código de idioma com duas letras ou uma combinação de código de idioma e código de região: "en" ou "en-US", por exemplo.
looker_versions
string[]
modelos_dir_validados
booleano
O espaço de trabalho de desenvolvimento do usuário foi verificado quanto à presença de projetos de produção aplicáveis
ID_da_pasta_pessoal
string
ID da pasta pessoal do usuário
presumido_empregador_funcionário
booleano
O usuário é identificado como um funcionário do Looker
IDs_do_papel
string[]
sessions
Expandir definição da sessão...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
id
string
ID exclusivo
ip_address
string
Endereço IP do usuário quando esta sessão foi iniciada
navegador
string
Tipo de navegador do usuário
operating_system
string
Sistema operacional do usuário
cidade
string
Componente Cidade do local do usuário (derivado do endereço IP)
estado
string
Componente "Estado" da localização do usuário (derivado do endereço IP)
country
string
Componente "País" do local do usuário (derivado do endereço IP)
tipo_de_credenciais
string
Tipo de credenciais usadas para a geração de registros nesta sessão
estendida_em
string
Hora em que a sessão foi estendida pela última vez pelo usuário
contagem_estendida
integer
Número de vezes em que a sessão foi estendida
sudo_user_id
string
Usuário real no caso em que esta sessão representa um usuário fazendo login como outro
criado_em
string
Hora em que esta sessão foi iniciada
expira em
string
Horário de expiração da sessão
url
string
Link para obter este item
estado_da_UI
objeto
Por dicionário do usuário de informações de estado não documentadas de propriedade da IU do Looker.
verificado_funcionário_funcionário
booleano
O usuário é identificado como um funcionário da Looker verificado por meio da autenticação corporativa da Looker
papéis_externos_gerenciados
booleano
As funções do usuário são gerenciadas por um diretório externo, como SAML ou LDAP, e não podem ser alteradas diretamente.
funções_permitir_diretos
booleano
O usuário pode receber uma função diretamente.
allow_normal_group_membership
booleano
O usuário pode ser um membro direto de um grupo normal do Looker.
allow_roles_from_normal_groups
booleano
O usuário pode herdar papéis de um grupo normal do Looker.
código_da_pasta_de_grupo_incorporado
string
(Somente incorporar) ID da pasta do grupo do usuário com base no external_group_id especificado opcionalmente durante o login de usuário incorporado
url
string
Link para obter este item

400: Solicitação inválida

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

404: não encontrado

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

Examples

Python

https://github.com/looker-open-source/sdk-codegen/blob/main/examples/python/add_users_to_group_from_csv.py
https://github.com/looker-open-source/sdk-codegen/blob/main/examples/python/cloud-function-user-provision/main.py
https://github.com/looker-open-source/sdk-codegen/blob/main/examples/python/disable_users_by_email.py
https://github.com/looker-open-source/sdk-codegen/blob/main/examples/python/transfer_all_schedules.py (em inglês)
https://github.com/looker-open-source/sdk-codegen/blob/main/python/tests/integration/test_methods.py

TypeScript

https://github.com/looker-open-source/sdk-codegen/blob/main/examples/typescript/sudoAsUser.ts
https://github.com/looker-open-source/sdk-codegen/blob/main/packages/hackathon/src/models/Hacker.ts
https://github.com/looker-open-source/sdk-codegen/blob/main/packages/sdk-node/test/methods.spec.ts
https://github.com/looker-open-source/sdk-codegen/blob/main/packages/sdk-node/test/methods.spec.ts
https://github.com/looker-open-source/sdk-codegen/blob/main/packages/sdk-node/test/methods.spec.ts
https://github.com/looker-open-source/sdk-codegen/blob/main/packages/sdk-node/test/methods.spec.ts
https://github.com/looker-open-source/sdk-codegen/blob/main/packages/sdk-node/test/methods.spec.ts

Kotlin

https://github.com/looker-open-source/sdk-codegen/blob/main/kotlin/src/test/TestSmoke.kt (em inglês)

Swift

https://github.com/looker-open-source/sdk-codegen/blob/main/swift/looker/Tests/lookerTests/methodsTests.swift (em inglês)
https://github.com/looker-open-source/sdk-codegen/blob/main/swift/looker/Tests/lookerTests/smokeTests.swift (em inglês)