Pular para o conteúdo principal

Usuários do portal

As pessoas que entram no portal em nome de um titular (o tenant_id). create convida um usuário (invite create é a mesma rota com nome de verbo), resend reenvia o convite ou a verificação, email-preview mostra o e-mail sem enviá-lo, e activity get / activity timeline get trazem os logins e as páginas visitadas.

ComandoHTTPDescrição
portal-users listGET /v1/portal_usersListar usuários do portal
portal-users createPOST /v1/portal_usersCriar (convidar) usuário do portal
portal-users getGET /v1/portal_users/{id}Obter usuário do portal
portal-users updatePATCH /v1/portal_users/{id}Atualizar usuário do portal
portal-users deleteDELETE /v1/portal_users/{id}Excluir usuário do portal
portal-users email-previewGET /v1/portal_users/{id}/email-previewPré-visualizar e-mail do usuário do portal
portal-users resendPOST /v1/portal_users/{id}/resendReenviar e-mail de convite ou verificação
portal-users activity getGET /v1/portal_users/{id}/activityConsultar a atividade do usuário do portal
portal-users activity timeline listGET /v1/portal_users/{id}/activity/timelineListar a linha do tempo do usuário do portal
portal-users invite createPOST /v1/portal_users/inviteConvidar usuário do portal

Exemplos​

--params carrega parâmetros de query, de caminho e de cabeçalho (id, página, filtros, X-Workspace-Id); --json carrega o corpo da requisição; --fields limita os campos que voltam — vale a pena em todo list/get, para economizar contexto. Veja Flags globais para a referência completa.

# Listar usuários do portal
kobana dashboards portal-users list \
  --params '{"status": "active", "per_page": 50}' \
  --fields "id,email,tenant_id,last_login_at"

# Criar (convidar) usuário do portal
kobana dashboards portal-users create \
  --json '{"email": "ana@example.com", "tenant_id": "12345678000190"}'

# Reenviar e-mail de convite ou verificação
kobana dashboards portal-users resend --params '{"id": "PORTAL_USER_ID"}'

# Consultar a atividade do usuário do portal
kobana dashboards portal-users activity get \
  --params '{"id": "PORTAL_USER_ID", "days": 30}'

# Atualizar usuário do portal
kobana dashboards portal-users update \
  --params '{"id": "PORTAL_USER_ID"}' \
  --json '{"status": "suspended"}'

Próximos passos​