Acessar valores de atributo do usuário

Versão 4.0.23.6 (mais recente)

Recebe os valores de atributo do usuário para um usuário específico.

Retorna os valores de atributos do usuário especificados (ou todos os atributos do usuário) para um determinado usuário.

É pesquisado um valor para cada atributo de usuário nos seguintes locais, nesta ordem:

  1. nas informações da conta do usuário
  2. em grupos dos quais o usuário seja membro
  3. o valor padrão do atributo do usuário

Se mais de um grupo tiver um valor definido para um atributo de usuário, o grupo com a classificação mais baixa será o vencedor.

A resposta incluirá apenas atributos de usuário para os quais foram encontrados valores. Use include_unset=true para incluir registros vazios para atributos do usuário sem valor.

O valor de todos os atributos de usuário ocultos ficará em branco.

Solicitação

GET /users/{user_id}/attribute_values
Tipo de dados
Descrição
Solicitação
HTTPRequest
path
HTTPPath
Expandir definição HTTPPath...
user_id
string
ID do usuário
consulta
Consulta HTTP
Expandir a definição de HTTPQuery...
campos
string
Campos solicitados.
ids_do_atributo_do_usuário
string[]
todos_valores
booleano
Se verdadeiro, retorna todos os valores no caminho da pesquisa, em vez de apenas o primeiro valor encontrado. Útil para depurar a precedência do grupo.
incluir_não definido
booleano
Se verdadeiro, retorna um registro vazio para cada atributo solicitado que não tem usuário, grupo ou valor padrão.

Resposta

200: valor do atributo do usuário.

Tipo de dados
Descrição
pode
objeto
Operações que o usuário atual pode realizar neste objeto
nome
string
Nome do atributo do usuário
Rótulo
string
Rótulo humano para o atributo do usuário
rank
integer
Precedência para definir o valor do usuário (menores ganhos)
valor
string
Valor do atributo do usuário
user_id
string
ID do usuário
user_can_edit
booleano
O usuário pode definir esse valor
valor_é_oculto
booleano
Se for verdadeiro, o campo "valor" será nulo, porque as configurações do atributo bloqueiam o acesso a esse valor
ID do atributo de usuário
string
ID do atributo do usuário
source
string
Como o usuário recebeu esse valor para este atributo
valor_do_domínio_oculto
string
Se este atributo de usuário estiver oculto, lista de destinos permitidos para onde ele pode ser enviado.

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