Permissions: Difference between revisions

From PHENOM Portal Knowledgebase
Jump to navigation Jump to search
No edit summary
No edit summary
Line 3: Line 3:
= Permissions Types =
= Permissions Types =
== Read Permissions ==
== Read Permissions ==
'''If a user has Read permissions, they have the most basic access to a project or model.'''
'''If a user has Read permissions, they have read-only access to the project or model.'''


The user is allowed to switch to a project to which they have Read permissions to all the contained models. The user is allowed to see all the content of their Read access projects and models. The user is also allowed to export their project for use elsewhere. In addition, if the model inherits from another model, a user with Read permissions is allowed to see the nodes that can be pulled from a parent model, but are prevented from actually pulling that content. Likewise, if a model has other models that inherit from it, a user with Read permissions to the model is allowed to see the push requests from the children models, but is not allowed to approve those changes.  
Having Read permissions to a project and its models allows the user to switch to that project, see all the content, export the content, but not create, edit, or update it. In addition, if the model inherits from another model, a user with Read permissions is allowed to see the nodes that can be pulled from a parent model, but are prevented from actually pulling that content. Likewise, if a model has other models that inherit from it, a user with Read permissions to the model is allowed to see the push requests from the children models, but is not allowed to approve those changes.  


Read permissions are also unique from the other permissions types because in order to have any other permissions, a user is required to also have Read access, to prevent scenarios where a user is allowed to edit model content that they are not even allowed to see. This is why a user wanting to assign Write or Admin permissions are not allowed to disable Read permissions, as seen below.
Read permissions are unique from the other permissions types in that they are required in order to have any other permissions. For that reason, when assigning Write, Admin, or Owner permissions, Read permissions are assigned by default and can't be removed, as seen below.


'''UPDATE IMAGE WITH OWNER COLUMN FILLED'''
[[File:Perms5.png|alt=Uncheckable Read Permissions Boxes|frameless|742x742px]]
[[File:Perms5.png|alt=Uncheckable Read Permissions Boxes|frameless|742x742px]]


Line 14: Line 15:
'''If a user has Write permissions, they are allowed to edit project and model content.'''
'''If a user has Write permissions, they are allowed to edit project and model content.'''


The user is able to modify fields on the details pages of nodes in the model, as well as the majority of the actions related to inheriting models. If the model inherits from another model, the user with Write access is able to request to push content to the parent model. Assuming that the user also has Read permissions to the parent model, the user is also allowed to pull any new changes from the parent model. Likewise, if a model has other models that inherit from it, a user with Write permissions to the model is allowed to approve content changes and delete push requests.
Having Write permissions to a project or a model allows the user to modify any of its content, including pulling, pushing, and approving push requests.
 
The user is able to create, edit, and delete elements, as well as perform the majority of the actions related to inheriting models '''WHAT ACTIONS CAN'T BE PERFORMED?'''. If the model inherits from another model, the user with Write access is able to request to push content to the parent model. Assuming that the user also has Read '''WRITE?''' permissions to the parent model, the user is also allowed to pull any new changes from the parent model. Likewise, if a model has other models that inherit from it, a user with Write permissions to the model is allowed to approve content changes and delete push requests. '''I THOUGHT WE COULDN'T DELETE PUSH REQUESTS'''


== Admin Permissions ==
== Admin Permissions ==
'''If a user has Admin permissions, they are allowed to make changes to projects and models themselves.'''
'''If a user has Admin permissions, they are allowed to make changes to projects and models themselves.'''


A user who has Admin access to projects or models is allowed to change the permissions of users who belong to the same account as them to the project or model, up to their own level of Admin. A user with Admin access to a model is also allowed to create inheriting models from it. A user who is an Admin for a project or model is also allowed to rename those projects and models.
Having Admin permissions to a project or a model allows the user to change the metadata of the project or model and create inheriting projects or models. They can also set the permissions of other users (belonging to their own account) to this project or model up to Admin.


== Owner Permissions ==
== Owner Permissions ==
'''If a user has Owner permissions (or "owns" a project or model), they were the creator of the project or model, and therefore have all of the above permissions types, as well as some more actions limited to just the owner of the project or model.'''
'''If a user has Owner permissions, they have all of the above permissions types, as well as some additional actions.'''
 
A user that owns a project or model is allowed to change permissions, both to users that belong to the same account as them (up to Owner level), as well as external users, sharing permissions with them via Permissions Tokens (up to Admin level). If a user owns a project and wishes to give other users permissions to it that are higher than those users currently have, the user must also have Admin permissions to all the contained models. In addition, the Owner of a project or model is the only user allowed to delete the projects and models they own.


It should be noted that if a project or model was created before April 2nd, 2024, the project or model may have more than one Owner. When Owner permissions were added, the Owner of a given project or model was determined to be anyone who had Admin permissions to that project or model, excluding any user who received Admin access via a Permissions Token. All projects and models created after April 2nd, 2024, only have one Owner.  
Having Owner permissions to a project or a model provide the user with Admin permissions plus the ability to delete the project or model, and to share it with users external to their account. Owner users can grant permissions up to Owner for internal users and Admin for external users.
If a user owns a project and wishes to give other users permissions to it that are higher than those users currently have, the user must also have Admin permissions to all the contained models '''WHAT?'''.


= Assign Permissions =  
= Assign Permissions =  
Line 54: Line 56:


== Account Admins ==
== Account Admins ==
Account admins are able to see all the projects and models that exist on their account, and are able to assign permissions to those projects and models to any user on the same account. In the case that a project or model was shared to someone on an account using a Permissions Token, that account's Admins are only allowed to assign permissions to the project or model that someone on the account holds.
Account admins are able to see all the projects and models that exist on their account, and are able to assign permissions to those projects and models to any user on the same account up to Owner permissions. In case a project or model was shared to someone on an account using a Permissions Token, that account's Admins are only allowed to assign permissions to the project or model that someone on the account holds. '''WHAT?'''

Revision as of 12:09, 29 April 2024

Permissions are a user's access level to either a project or a model. There are four different types of permissions, and a user can have any of the permissions types independent of one another.

Permissions Types

Read Permissions

If a user has Read permissions, they have read-only access to the project or model.

Having Read permissions to a project and its models allows the user to switch to that project, see all the content, export the content, but not create, edit, or update it. In addition, if the model inherits from another model, a user with Read permissions is allowed to see the nodes that can be pulled from a parent model, but are prevented from actually pulling that content. Likewise, if a model has other models that inherit from it, a user with Read permissions to the model is allowed to see the push requests from the children models, but is not allowed to approve those changes.

Read permissions are unique from the other permissions types in that they are required in order to have any other permissions. For that reason, when assigning Write, Admin, or Owner permissions, Read permissions are assigned by default and can't be removed, as seen below.

UPDATE IMAGE WITH OWNER COLUMN FILLED Uncheckable Read Permissions Boxes

Write Permissions

If a user has Write permissions, they are allowed to edit project and model content.

Having Write permissions to a project or a model allows the user to modify any of its content, including pulling, pushing, and approving push requests.

The user is able to create, edit, and delete elements, as well as perform the majority of the actions related to inheriting models WHAT ACTIONS CAN'T BE PERFORMED?. If the model inherits from another model, the user with Write access is able to request to push content to the parent model. Assuming that the user also has Read WRITE? permissions to the parent model, the user is also allowed to pull any new changes from the parent model. Likewise, if a model has other models that inherit from it, a user with Write permissions to the model is allowed to approve content changes and delete push requests. I THOUGHT WE COULDN'T DELETE PUSH REQUESTS

Admin Permissions

If a user has Admin permissions, they are allowed to make changes to projects and models themselves.

Having Admin permissions to a project or a model allows the user to change the metadata of the project or model and create inheriting projects or models. They can also set the permissions of other users (belonging to their own account) to this project or model up to Admin.

Owner Permissions

If a user has Owner permissions, they have all of the above permissions types, as well as some additional actions.

Having Owner permissions to a project or a model provide the user with Admin permissions plus the ability to delete the project or model, and to share it with users external to their account. Owner users can grant permissions up to Owner for internal users and Admin for external users.

If a user owns a project and wishes to give other users permissions to it that are higher than those users currently have, the user must also have Admin permissions to all the contained models WHAT?.

Assign Permissions

Assign Permissions to a Project or Model

Users are able to assign permissions to their projects and models by using the Permission Manager on the Project Details and Model Details pages. The table lists all the users from the same account as the current user.

Project Details Page Permissions Manager

Assign Permissions to External Users

To assign permissions to users that do not belong to the current user's account, the user has to give them a Permissions Token. The procedure to do so is as follows:

  • Go to the Project Sharing page
  • Locate the project or model to be shared
  • Enter the username and the desired permissions level
  • Click the Share button
  • Email the generated Token (which appeared on the right of the screen) to the user.

Note that the Token is only valid for 24 hours.

Project Sharing Page

To gain access to the project or model, the user has to go to the Project Sharing page, copy the Token received by email in the dedicated field and click the Submit button. The new project or model should then appear in the their project/model tree.

Accepting Perms Token

This user, along with any other external users, will appear in the Permissions Manager under a separate External Users table.

Project Details with External Users Permissions

Account Admins

Account admins are able to see all the projects and models that exist on their account, and are able to assign permissions to those projects and models to any user on the same account up to Owner permissions. In case a project or model was shared to someone on an account using a Permissions Token, that account's Admins are only allowed to assign permissions to the project or model that someone on the account holds. WHAT?