Pular para o conteúdo principal

kobana billing portal-users

Lista usuários do portal

Comandos de kobana billing portal-users. Toda opção global (Opções globais) vale aqui.

ComandoHTTPDescrição
portal-usersGET /v1/portal_usersLista usuários do portal

portal-users​

Lista usuários do portal

kobana billing portal-users [OPÇÕES]

GET /v1/portal_users

Retorna os usuários do portal do cliente na organização autenticada, com paginação. Campos sensíveis (senha, tokens) nunca são expostos.

Parâmetros de consulta

NomeTipoObrigatórioDescrição
pageintegernãoPágina (começa em 1). Padrão: 1.
per_pageintegernãoItens por página. Padrão: 20. Máximo: 100.
sort_bystringnãoCampo de ordenação. Padrão depende do recurso.
sort_orderstringnãoDireção da ordenação. Padrão: desc. Valores: asc, desc.
billing_account_idstringnãoRestringe a uma conta de cobrança específica.
customer_idstringnãoRestringe a todas as contas de cobrança de um cliente. Aceita o id do cliente ou o external_id.
statusstringnãoFiltra por status: active, pending_invitation, pending_verification, suspended ou locked. Valores: active, pending_invitation, pending_verification, suspended, locked.
emailstringnãoBusca por trecho do e-mail.

Respostas

HTTPDescrição
200Lista paginada de usuários do portal.
404Recurso não encontrado na organização atual.