Updating User and Group Access Permissions to a Project or Project Space Programmatically

This example helps you create a pipeline which will, when executed, update the access permissions of a specific user or group to a project or project space.

Download and open the Permissions_Updater sample pipeline and review its structure to better understand this example.

This task primarily involves updating the "acl" (access control list) values associated with the project concerned. To do so, you need to:

1. Read the project's existing permissions information.
2. Append new permissions information.
3. Update the project with the new permissions.

You can perform all these tasks by creating a permissions manager pipeline. To create a permissions manager pipeline:

1. Create a project and add a pipeline to the project.
   Now that your pipeline is created, you need to specify the variables–and corresponding values–that you plan to use in the pipeline Snaps. In this scenario, you have two variables: the email ID of the user or group whose permissions you need to specify, and the project or project space to which you want to grant access. To specify these variables:
2. Click the  button on the Pipeline Toolbar to display the Pipeline Properties popup.
3. Update the Parameters fieldset of the Pipeline Properties popup as follows:
   1. Declare a variable that will contain the new user's email ID.
      1. Key: new_user
      2. Value: <Email ID of the new user / group>
   2. Declare a variable that contains the path to the project that you want to update.
      1. Key: project_path
      2. Value: <Path to the project / project space that you want to update. Structure: /<organization>/<project_space>/<project_name>
4. Save your changes and close the popup.
   
   
   
   You have now listed out the email ID of the user / group whose permissions you want to update, and you have identified the project / project space on which these permissions must be applied. You now add a Snap that will read the identified project's existing user permissions. To do so:
   
   
5. Add a SnapLogic Read snap to the pipeline and update it using the following details:
   
   • Asset Type: PROJECT
   • Asset Path: (Click the  button before adding the value.) _project_path. This is a reference to the pipeline parameter that we created in Step 3 above.
     
     
   Save your changes and close the popup.
   
   
   
   When this Snap is executed, it retrieves all the data related to the project / project space, including its permission details.
   
   You now need to append new permissions to the existing ones. To do so:
   
   
6. Add a Mapper Snap to the pipeline and update the following fields:
   

   1. Expression: Enter the following expression:

      Paste code macro
      [].concat($acl, [{"perms":["R","W","X"],"subject_type":"USER","inherit":true,"subject":_new_user}])

      This expression contains the new permission values that you want to add under the "acl" key in the project. Depending on the actual permissions you want to assign to the user, remove 'R', 'W', or 'X'.
      
      

   2. Target Path: $acl
      
      Save your changes and close the popup.
      
      
      
      You can see in the screenshot above that while the Input preview data field lists only one set of permissions, the Output preview data lists two permission sets. The second one is the new permission set added.
      
      You now have all the details needed to update the project properties retrieved using the SnapLogic Read Snap. To update the project:
      
      
7. Add a SnapLogic Update Snap to the pipeline and update the following fields:
   1. Asset Type: PROJECT
   2. Asset Path: (Click the  button before adding the value.) _project_path
      Save your changes and close the popup.
      
      
      
      

Once this Pipeline is executed, the project located at _project_path will be updated with the revised permissions specified in the Mapper Snap in Step 5 above. You can now flexibly update the properties of any project / project space from the same pipeline by changing any of the following values:

Updating Access Permissions of Multiple Users or Groups to Multiple Projects or Project Spaces Programmatically

This example helps you create a pipeline which will, when executed, update the access permissions of multiple users or groups to multiple project spaces.

Download and open the Multiple_Permissions_Updater ZIP file and review its structure to better understand this example.

This task primarily involves updating the "acl" (access control list) values associated with the project space concerned. To do so, you need to:

1. List out the various users and groups to whom you want to apply new permissions, along with the projects or project spaces on which these permissions are applicable.
2. Read each project's existing permissions information.
3. Append the new permissions.
4. Update the projects with the new permissions.

You can perform all these tasks by creating:

• A parent pipeline that takes a CSV file containing user email IDs and project permission details as input, and
• A child pipeline that applies the access permissions received from the parent pipeline.

Creating the Parent Pipeline

To create the parent pipeline:

1. Add a CSV Generator Snap and add user details and associated project permissions as shown below:
   
   
   
   For an example of the CSV data, see the permissions.csv file in the ZIP file you downloaded.
2. Add a CSV Formatter and a CSV Parser Snap. These Snaps read the CSV data and prepares it for use in the downstream Snap.
3. Add a Pipeline Execute Snap and configure it as shown below:
   
   
   
   Basically, your configurations trigger a child pipeline called Permission_Updater and pass user and project information from the input CSV file to the child pipeline.
4. Save the pipeline.

Creating the Child Pipeline

1. Create a project
2.  and add a pipeline
3.  to the project.
   
   Now that your pipeline is created, you need to specify the variables–and corresponding values–that you plan to use in the pipeline Snaps. In this scenario, you have two variables: the email ID of the user whose permissions you need to modify / create, and the project space to which you want to grant access. To specify these variables:
4. Click the  button on the Pipeline Toolbar to display the Pipeline Properties popup.
5. Update the Parameters fieldset of the Pipeline Properties popup as follows:
   1. Declare a variable that will contain new users' email IDs
      1. Key: new_user
      2. Value: <Email ID of the new user>
      1. Key: project_space_path
      2. Value: <Path to the project space that you want to update. Structure: /<organization>/<project_space>
         
         The data in the Values fields are actually placeholders, placed there because Value is a mandatory field. The actual user and project data comes in from the parent pipeline.
6. Save your changes and close the popup.
   
   
   
   You have now configured the new pipeline to take user and permissions input from the parent pipeline. You now add a Snap that will read each project's existing user permissions. To do so:
   
   
7. Add a SnapLogic Read snap to the pipeline and update it using the following details:
   
   • Asset Type: PROJECT (You do not need to change this value even if you are updating permissions for project spaces.)
   • Asset Path: (Click the  button before adding the value.) _project_path. This is a reference to the pipeline parameter that we created in Step 3 above.
     
     
   Save your changes and close the popup.
   
   
   
   When this Snap is executed, it retrieves all the data related to each project listed out in the parent pipeline CSV file, including its permission details.
   
   You now need to append new permissions to the project. To do so:
   
   
8. Add a Mapper Snap to the pipeline and update the following fields:
   

   1. Expression: Enter the following expression:

      Paste code macro
      [].concat($acl, [{"perms":["R","W","X"],"subject_type":"USER","inherit":true,"subject":_new_user}])

      This expression contains the new permission values that you want to add under the "acl" key in each project / project space. Depending on the actual permissions you want to assign to the user / group, remove 'R', 'W', or 'X'.
      
      

   2. Target Path: $acl
      
      Save your changes and close the popup.
      
      
      
      You can see in the screenshot above that while the Input preview data field lists only one set of permissions, the Output preview data lists two permission sets. The second one is the new permission set added.
      
      You now have all the details needed to update the project properties received from the parent pipeline. To update each project space with the revised permission details:
      
      
9. Add a SnapLogic Update Snap to the pipeline and update the following fields:
   1. Asset Type: PROJECT
   2. Asset Path: (Click the  button before adding the value.) _project_path
      Save your changes and close the popup.
      
      
      
      

Once this pipeline is executed, each project located at _project_path will be updated with the revised permissions specified in the Mapper Snap in Step 5 above. You can now flexibly update the properties of any project from the same pipeline by changing any of the following values: