Permissions System
Learn about Kyso's Enterprise permissions system...

Introduction

The following document describe how the permission system works at Kyso, which is highly customisable, in which we can create roles with finely grained permissions to configure how your users can behave on the platform.
We have default access controls on deployment, but you can contact our Support team to talk about customising user roles in your company's Kyso installation.

Platform Roles

Kyso has default access controls on deployment, but you can contact our Support team to talk about customising user roles in your company's Kyso installation.
Below is a list of the predefined roles named platform roles. These roles are the most common ones, and are “self-explanatory”. The roles are the following:
  • Platform admin
  • Organization admin
  • Team admin
  • Team contributor
  • Team reader

Role Access Levels

Table Legend

  • 🎷 -> Only for the entities that the user is owner or belongs to (comments, reports, repos, organizations, etc…). That means that user can’t perform these actions in other teams/discussions/reports/etc. in which he/she is not member of nor owns it
  • 🔓 -> Only public teams accessed directly with the URL

Platform Organisational Structure

1. Organizations

An organization is a management unit at Kyso to manage the permissions and the behaviour of users that belongs to it. Consider that:
  • Every user belongs to at least one organization
    • Every time a new user is created at Kyso, a new organization “{{username}}’s Workspace” is created (i.e. this is their personal workspace)
  • An user can belong to more than one organization

2. Teams

A team is a management unit at Kyso, to manage the visibility and the behaviour of the users. Consider that:
  • Every user belongs to at least one team
    • Every time a new user is created, a new team “{{usernames}}’ Private Team” is created and linked to “{{usernames}}’s Workspace”
  • A user can belong to more than one team
  • A team can be:
    • Public: Every user on the company's Kyso account can access that team
    • Protected: Only users that belong to the organization that owns the team can access that team
    • Private: Only users with a specific invitation can access that team

3. Reports

A report is an instance of an imported notebook (Jupyter, etc.) or other file type. All the data, comments, collaboration, etc. is done inside a report. Consider that:
  • Every report belongs to a team

Custom Roles

The permission system allows the creation of new roles, with a specific bunch of permissions, in organization and team scopes.
Contact our Support team for more info on this!
That means:
  • An organization admin can create a new role that is only valid inside its organization
    • Then, the users that belong to that organization can be configured to use:
      • All the Platform Roles
      • The custom roles of that organization
  • A team admin can create a new role that is only in valid inside its team.
    • Then, the users that belong to that team can be configured to use:
      • All the Platform Roles
      • The custom roles of the organization that owns the team (if there is)
      • The custom roles of that team

Authorization Hierarchy

.
└── Platform Roles
└── Organization Roles
└── Team Roles
Copy link
On this page
Introduction
Platform Roles
Role Access Levels
Platform Organisational Structure
1. Organizations
2. Teams
3. Reports
Custom Roles
Authorization Hierarchy