Skip to main content

Team roles

The roles that define what each dashboard user can do.

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

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 team roles
kobana billing team-roles list \
--fields "id,public_id,organization_id,name,slug"

# Get a role
kobana billing team-roles get --params '{"id": "TEAM_ROLE_ID"}'

# Create a custom role
kobana billing team-roles create \
--json '{"name": "NAME", "slug": "billing_manager", "permissions": []}'

# Update a role
kobana billing team-roles update \
--params '{"id": "TEAM_ROLE_ID"}' \
--json '{"name": "NAME", "slug": "SLUG", "description": "DESCRIPTION"}'

# Remove a role
kobana billing team-roles delete --params '{"id": "TEAM_ROLE_ID"}' --dry-run

Next steps​