Skip to main content

Portal users

The people who sign in to the portal on behalf of a tenant (the tenant_id). create invites a user (invite create is the same route under a verb name), resend sends the invitation or verification again, email-preview shows the e-mail without sending it, and activity get / activity timeline get return sign-ins and visited pages.

CommandHTTPDescription
portal-users listGET /v1/portal_usersList portal users
portal-users createPOST /v1/portal_usersCreate (invite) portal user
portal-users getGET /v1/portal_users/{id}Get portal user
portal-users updatePATCH /v1/portal_users/{id}Update portal user
portal-users deleteDELETE /v1/portal_users/{id}Delete portal user
portal-users email-previewGET /v1/portal_users/{id}/email-previewPreview portal user email
portal-users resendPOST /v1/portal_users/{id}/resendResend invitation or verification email
portal-users activity getGET /v1/portal_users/{id}/activityGet portal user activity
portal-users activity timeline listGET /v1/portal_users/{id}/activity/timelineList portal user activity timeline
portal-users invite createPOST /v1/portal_users/inviteInvite portal user

Examples​

--params carries query, path and header parameters (id, page, filters, X-Workspace-Id); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference.

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

# Create (invite) portal user
kobana dashboards portal-users create \
  --json '{"email": "ana@example.com", "tenant_id": "12345678000190"}'

# Resend invitation or verification email
kobana dashboards portal-users resend --params '{"id": "PORTAL_USER_ID"}'

# Get portal user activity
kobana dashboards portal-users activity get \
  --params '{"id": "PORTAL_USER_ID", "days": 30}'

# Update portal user
kobana dashboards portal-users update \
  --params '{"id": "PORTAL_USER_ID"}' \
  --json '{"status": "suspended"}'

Next steps​