Skip to main content

Roles

The team roles and the permissions each one grants members. update creates or updates a role by slug or id; the available permissions come from permissions list.

CommandHTTPDescription
team-roles listGET /v1/team_rolesList team roles
team-roles createPOST /v1/team_rolesCreate custom role
team-roles updatePUT /v1/team_rolesCreate or update a team role
team-roles getGET /v1/team_roles/{id}Get role
team-roles deleteDELETE /v1/team_roles/{id}Remove role

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 team roles
kobana dashboards team-roles list --fields "id,name,slug,is_system,users_count"

# Create custom role
kobana dashboards team-roles create \
  --json '{"name": "Integrações", "slug": "integrations_manager", "permissions": ["integrations.list", "integrations.show", "integrations.update"]}'

# Get role
kobana dashboards team-roles get --params '{"id": "ROLE_ID"}'

Next steps​