Consultar Usuários

API responsável por listar os usuários da corporação autenticada.

URL	/corporation-user
Methods	GET
Headers
Authorization	Bearer *** onde *** é o token obtido na autenticação de usuário
Search Params
page	Number | Opcional | Número da página na paginação.
search	String | Opcional | Valor a ser consultado nos campos nome e CPF do usuário.
status	Number | Opcional | Filtra os usuários pelo seu status seguindo a seguinte lógica: - habilitados = 0 - bloqueados = 2 - removidos = 4 - bloqueados e removidaos = 6
hideEnabled	Bit | Opcional | Quando informado, a consulta não trás os usuários habilitados.
userClass	String | Opcional | Classe dos usuários a serem consultados. Pode receber os valores user_corporation, user_signer
Success Response	Code: 200 { "_embedded": { "corporation_user": [ { "id": 285, "status": 0, "username": "99451948104", "name": "CERTIFICADO TESTE VAULTID", "email": null, "phoneNumber": null, "userUnique": "e2c8080fbf079a79daafb484f3f3a46e", "userType": null, "userClass": "user_corporation", "serialNumber": null, "initDate": { "date": "2021-04-08 00:00:00.000000", "timezone_type": 3, "timezone": "UTC" }, "updatedDateTime": { "date": "2024-04-08 01:58:07.000000", "timezone_type": 3, "timezone": "UTC" }, "activationDate": { "date": "2022-03-30 00:00:00.000000", "timezone_type": 3, "timezone": "UTC" }, "expireAt": { "date": "2025-04-07 23:59:59.000000", "timezone_type": 3, "timezone": "UTC" }, "expireAtCertificate": null, "expireTime": null, "autoRenovation": null, "inheritedExpireTime": "+1 year", "inheritedAutoRenovation": 1, "_links": { "self": { "href": "https://billing.hom.vaultid.com.br/corporation-user/285" } } }, ... ] }, "page_count": 2, "page_size": 25, "total_items": 41, "page": 1 }
Error Response	Code: 401 Content: { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "User auth error." }

Exemplo

curl --location 'https://billing.hom.vaultid.com.br/corporation-user?page=1&status=0' \
--header 'Authorization: Bearer 5febf3bc80a6615ad2fecbcae61670bf9e123a98'

Ambientes

• Homologação: https://billing.hom.vaultid.com.br

• Produção: https://billing.vaultid.com.br