Obter usuários por atributo do servidor

post/attributes/users/get

Obtém uma lista de usuários por um atributo. Retorna uma lista dos IDs dos usuários, seus e-mails e os atributos que foram especificados no objeto 'key' da solicitação.

SecurityAttributesServer

Request

Request Body schema: application/json

required

object

O atributo é usado para obter a lista de usuários.

key required	string <= 256 characters [A-Za-z0-9_]+ Nome do atributo utilizado para identificar o atributo do usuário. Deve ser exclusivo para cada usuário.
value	string or null Valor do atributo do usuário. Necessário para obter usuários com o parâmetro `key` com esse valor. Se você não especificá-lo, ele retornará todos os usuários com qualquer valor para essa chave.

after

string or null

Data de atualização do atributo do usuário e ID do atributo mais recente na lista keys. Não o defina na primeira vez. Quando você obtém usuários por atributo, eles são classificados por data de atualização. Se vários atributos tiverem a mesma data de atualização, eles serão classificados por ID de atributo. Ele é usado para paginação de API.

attr_type

string

Default: "client"

Definição do nível de acesso do usuário aos atributos de serviço.

Enum: "client" "server"

keys

Array of strings <= 5 items

Lista de chaves de atributos que você deseja obter. Se você não especificá-las, o método retornará todos os atributos do usuário.

limit

integer [ 0 .. 20 ]

Default: 20

Número de usuários retornados ao pesquisar por atributo.

login_project_id

string

ID de login da Conta de Distribuidor para a qual você deseja obter os atributos do usuário. Se você especificá-lo, ele será usado em vez do seu ID de comerciante e ID de projeto da Conta de Distribuidor.

publisher_id

integer or null

Seu ID de comerciante para o qual a solicitação é feita. Necessário para a autorização de solicitações.

publisher_project_id

integer

ID do projeto da Conta de Distribuidor para a qual você deseja obter usuários. Se você não especificá-lo, ele retornará usuários sem o valor desse parâmetro.

search_type

string

Default: "equal"

Condição de comparação que define critérios de pesquisa.

Enum: "equal" "like"

Responses

200

400

Pedido incorreto

403

Entidade não processável

422

Entidade não processável

429

Pedidos demais

Request samples

application/json

{"after": "string",
"attr_type": "client",
"attribute": {"key": "string",
"value": "string"
},
"keys": ["string"
],
"limit": 20,
"login_project_id": "string",
"publisher_id": 0,
"publisher_project_id": 0,
"search_type": "equal"
}

Response samples

application/json

[{"attributes": [{"attr_type": "client",
"data_type": "string",
"description": "string",
"format": "string",
"key": "string",
"permission": "public",
"readonly": true,
"value": "string"
}
],
"email": "string",
"user_id": "string"
}
]