Members

The people on your team who use the dashboard (the dashboard users). create sends the invitation and resend sends it again; update creates or updates a member by e-mail or id. workspaces get / workspaces update read and set the workspaces the member can access.

Command	HTTP	Description
dashboard-users list	GET /v1/dashboard_users	List dashboard users
dashboard-users create	POST /v1/dashboard_users	Invite dashboard user
dashboard-users update	PUT /v1/dashboard_users	Create or update a dashboard user
dashboard-users get	GET /v1/dashboard_users/{id}	Get dashboard user
dashboard-users delete	DELETE /v1/dashboard_users/{id}	Remove dashboard user
dashboard-users resend	POST /v1/dashboard_users/{id}/resend	Resend member invitation
dashboard-users workspaces get	GET /v1/dashboard_users/{id}/workspaces	Get member workspace access
dashboard-users workspaces update	PUT /v1/dashboard_users/{id}/workspaces	Set member workspace access

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 dashboard users
kobana dashboards dashboard-users list --fields "id,email,name,status,roles"

# Invite dashboard user
kobana dashboards dashboard-users create \
  --json '{"email": "joao@example.com", "name": "João", "role_ids": ["ROLE_ID"]}'

# Get member workspace access
kobana dashboards dashboard-users workspaces get \
  --params '{"id": "DASHBOARD_USER_ID"}'

# Set member workspace access
kobana dashboards dashboard-users workspaces update \
  --params '{"id": "DASHBOARD_USER_ID"}' \
  --json '{"workspace_ids": ["WORKSPACE_ID"]}'

Next steps

• Roles
• Permissions
• Schema introspection — every parameter this resource accepts.