Skip to main content

Dashboard users

Who has access to your organization's dashboard — the operators, not the customers.

CommandHTTPDescription
dashboard-users listGET /v1/dashboard_usersList dashboard users
dashboard-users createPOST /v1/dashboard_usersInvite a dashboard user
dashboard-users getGET /v1/dashboard_users/{id}Get a dashboard user
dashboard-users updatePATCH /v1/dashboard_users/{id}Update a dashboard user
dashboard-users deleteDELETE /v1/dashboard_users/{id}Remove a dashboard user

Examples​

--params carries query and path parameters (id, page, filters); --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 dashboard users
kobana billing dashboard-users list \
--fields "id,public_id,organization_id,person_id,external_id"

# Get a dashboard user
kobana billing dashboard-users get --params '{"id": "DASHBOARD_USER_ID"}'

# Invite a dashboard user
kobana billing dashboard-users create \
--json '{"email": "EMAIL", "role_ids": []}'

# Update a dashboard user
kobana billing dashboard-users update \
--params '{"id": "DASHBOARD_USER_ID"}' \
--json '{"name": "NAME", "picture": "PICTURE", "status": "active"}'

# Remove a dashboard user
kobana billing dashboard-users delete \
--params '{"id": "DASHBOARD_USER_ID"}' \
--dry-run

Next steps​