streamsets 6.6.0.dev1__tar.gz → 6.6.1rc1__tar.gz

{streamsets-6.6.0.dev1 → streamsets-6.6.1rc1}/HISTORY.rst

@@ -3,6 +3,26 @@
 
 History
 =======
+6.6.0 (June 2025)
+-----------------
+* Added support for interacting with network access rules
+
+    * Added the ability to modify whether network access rules are enabled for your organization using the :py:attr:`streamsets.sdk.sch_models.Organization.ip_auth_enabled` attribute.
+
+    * Added the ability to modify network access rules for your organization using the :py:meth:`streamsets.sdk.sch_models.Organization.add_ip_auth_ruleset` and :py:meth:`streamsets.sdk.sch_models.Organization.remove_ip_auth_ruleset`.
+
+    * Added the ability to view the current network access rules using the :py:attr:`streamsets.sdk.sch_models.Organization.ip_auth_rules` attribute.
+
+* Added functionality to check the possible values of a stage configuration by using the :py:meth:`streamsets.sdk.sch_models.PipelineBuilder.get_stage_configuration_options` method.
+
+* Added support for interacting with Projects
+
+    * Added SDK support for projects feature by being able to switch between different projects using the :py:attr:`streamsets.sdk.ControlHub.current_project` attribute.
+
+    * Added SDK support to list and modify projects by using the :py:attr:`streamsets.sdk.ControlHub.projects` attribute and the methods :py:meth:`streamsets.sdk.ControlHub.add_project` and :py:meth:`streamsets.sdk.ControlHub.delete_project`.
+
+* Bug fixes and improvements.
+
 6.5.0 (November 2024)
 -----------------
 * The :py:class:`streamsets.sdk.sch_models.Step` class now supports Finish Conditions and has a new attribute ``name`` which will allow retrieving and setting the name of a step.

streamsets-6.6.1rc1/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.1
+Name: streamsets
+Version: 6.6.1rc1
+Summary: A Python SDK for StreamSets
+Author: StreamSets Inc
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.4
+Description-Content-Type: text/x-rst
+Requires-Dist: dpath==1.5.0
+Requires-Dist: inflection
+Requires-Dist: PyYAML
+Requires-Dist: requests
+
+=========================
+StreamSets SDK for Python
+=========================
+
+|Version| |Python|
+
+.. |Python| image:: https://shields.io/pypi/pyversions/streamsets.svg?style=flat
+    :target: https://pypi.python.org/pypi/streamsets/
+    :alt: Python Versions
+.. |Version| image:: http://img.shields.io/pypi/v/streamsets.svg?style=flat
+    :target: https://pypi.python.org/pypi/streamsets/
+    :alt: Package Version
+
+The StreamSets SDK allows users to interact with StreamSets products programmatically using Python, including Control Hub, Data Collector, Transformer, and Transformer for Snowflake.
+
+Notices
+-------
+Versions 4.0.0 and higher of the StreamSets SDK for Python support the `StreamSets Platform <https://docs.streamsets.com/portal/platform-controlhub/controlhub/UserGuide/GettingStarted/GettingStarted_title.html>`_.
+Versions below 4.0.0 support our `Legacy products <https://docs.streamsets.com/portal/controlhub/latest/help/controlhub/UserGuide/GettingStarted/DPM.html#concept_l45_qwf_xw>`_.
+Please verify that the version of the SDK you're using is compatible with the StreamSets products you plan to interact with.
+
+Documentation
+-------------
+.. _documentation:
+
+For documentation on the StreamSets SDK for Platform, refer to our `Platform SDK documentation <https://docs.streamsets.com/platform-sdk/latest/index.html>`_.
+For documentation on the StreamSets SDK for Legacy products, refer to our `Legacy SDK documentation <https://docs.streamsets.com/sdk/latest/index.html>`_.
+
+More Resources
+--------------
+You can find training and additional resources on the `StreamSets Academy <https://academy.streamsets.com/learn/courses/45/streamsets-sdk-for-python>`_.
+
+You can also find a wealth of knowledge on the `StreamSets Community Forums <https://community.streamsets.com>`_ including product updates, workshops, events and webinars, and more!
+
+Getting Help
+------------
+Running into issues while using the StreamSets SDK?
+Get assistance from `StreamSets Support <https://www.ibm.com/mysupport>`_!
+
+Release Notes
+-------------
+Release notes for the Platform SDK can be found in the `Platform SDK release notes <https://docs.streamsets.com/platform-sdk/latest/welcome/release_notes.html>`_.
+
+Release notes for the Legacy SDK can be found in the `Legacy SDK release notes <https://docs.streamsets.com/sdk/latest/history.html>`_.

{streamsets-6.6.0.dev1 → streamsets-6.6.1rc1}/README.rst

@@ -23,7 +23,6 @@ Documentation
 -------------
 .. _documentation:
 
-You can find the latest, most updated documentation on our `documentation portal <https://docs.streamsets.com/>`_, including how to get started with the StreamSets SDK for Python.
 For documentation on the StreamSets SDK for Platform, refer to our `Platform SDK documentation <https://docs.streamsets.com/platform-sdk/latest/index.html>`_.
 For documentation on the StreamSets SDK for Legacy products, refer to our `Legacy SDK documentation <https://docs.streamsets.com/sdk/latest/index.html>`_.
 
@@ -36,10 +35,10 @@ You can also find a wealth of knowledge on the `StreamSets Community Forums <htt
 Getting Help
 ------------
 Running into issues while using the StreamSets SDK?
-Get assistance from `StreamSets Support <https://streamsets.com/support/>`_!
+Get assistance from `StreamSets Support <https://www.ibm.com/mysupport>`_!
 
 Release Notes
 -------------
-Release notes for the Platform SDK can be found in the `Platform SDK release notes <https://docs.streamsets.com/platform-sdk/latest/learn/release_notes.html>`_.
+Release notes for the Platform SDK can be found in the `Platform SDK release notes <https://docs.streamsets.com/platform-sdk/latest/welcome/release_notes.html>`_.
 
 Release notes for the Legacy SDK can be found in the `Legacy SDK release notes <https://docs.streamsets.com/sdk/latest/history.html>`_.

{streamsets-6.6.0.dev1 → streamsets-6.6.1rc1}/docs/api/sch_api.rst

@@ -205,6 +205,16 @@ Pipelines
 .. autoclass:: streamsets.sdk.sch_models.StPipelineBuilder
     :members:
 
+Projects
+^^^^^^^^
+
+.. autoclass:: streamsets.sdk.sch_models.Project
+    :members:
+.. autoclass:: streamsets.sdk.sch_models.Projects
+    :members:
+.. autoclass:: streamsets.sdk.sch_models.ProjectBuilder
+    :members:
+
 Protection Methods
 ^^^^^^^^^^^^^^^^^^
 .. autoclass:: streamsets.sdk.sch_models.ProtectionMethod

{streamsets-6.6.0.dev1 → streamsets-6.6.1rc1}/docs/build/creating_pipelines.rst

@@ -12,6 +12,7 @@ for pipelines.
 
 Instantiating a Pipeline Builder
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. _instantiate_builder:
 
 In the UI, a pipeline can be created and modified from the Pipelines section as seen below:
 

{streamsets-6.6.0.dev1 → streamsets-6.6.1rc1}/docs/build/editing_pipelines.rst

@@ -216,6 +216,32 @@ Setting the configuration value is as simple as directly setting the value in-me
 .. note::
   The same workflow can be followed to access/edit configuration values of :py:class:`streamsets.sdk.sch_models.Pipeline` objects
 
+Some configuration values have a predefined set of options to choose from.
+You can get a list of these using the :py:meth:`streamsets.sdk.sch_models.PipelineBuilder.get_stage_configuration_options` method, as shown below:
+
+.. code-block:: python
+
+    pipeline_builder.get_stage_configuration_options(
+        config_name="JSON Content",         # UI name of the configuration field
+        stage_name="Dev Raw Data Source",   # Name of the stage
+        config_name_type="label",           # Type of the config_name parameter (Default: label)
+        stage_name_type="label",            # Type of the stage_name parameter (Default: label)
+    )
+**Output:**
+
+.. code-block:: python:
+
+    [ChooseOption(UI_VALUE='JSON array of objects', SDK_VALUE='ARRAY_OBJECTS'), ChooseOption(UI_VALUE='Multiple JSON objects', SDK_VALUE='MULTIPLE_OBJECTS')]
+
+The list will match the values shown in the `JSON Content` UI dropdown.
+
+.. image:: ../_static/images/build/value_chooser__JSON_content.png
+
+.. tip::
+    Refer to the :ref:`Instantiating a Pipeline Builder<instantiate_builder>` section for creating a Pipeline Builder instance.
+
+|
+|
 Once you have edited your :py:class:`streamsets.sdk.sch_models.Pipeline` or :py:class:`streamsets.sdk.sch_models.SchSdcStage`, the changes must be published to Control Hub.
 This can be done by taking the updated :py:class:`streamsets.sdk.sch_models.Pipeline` instance and passing it into the :py:meth:`streamsets.sdk.sch.publish_pipeline` method as seen below:
 

streamsets-6.6.1rc1/docs/manage/projects/projects.rst

@@ -0,0 +1,242 @@
+Managing Projects
+=================
+|
+
+The SDK allows you to manage projects for your organization. This includes creating or deleting projects, managing users and groups
+that have access to a project.
+
+Creating A Project
+~~~~~~~~~~~~~~~~~~
+
+To create a Project on the Platform UI, you should go to Manage > Projects and click on the ``+`` icon.
+
+.. image:: ../../_static/images/manage/projects/create_project.png
+|
+
+To create a Project via the SDK, you need to instantiate a new instance of :py:class:`streamsets.sdk.sch_models.ProjectBuilder`
+to create a new instance of :py:class:`streamsets.sdk.sch_models.Project`.
+
+To instantiate the builder instance use :py:meth:`streamsets.sdk.ControlHub.get_project_builder` method.
+You can then call the :py:meth:`streamsets.sdk.sch_models.ProjectBuilder.build` method to create the new Project by supplying the ``name``
+and the optional ``description`` parameter.
+
+After instantiating the object, you can add it to Platform via the :py:meth:`streamsets.sdk.ControlHub.add_project`.
+
+.. code-block:: python
+
+    # Instantiate the ProjectBuilder
+    project_builder = sch.get_project_builder()
+
+    # build the project by passing name, and optionally a description
+    project = project_builder.build(name='Secret project', decription='Nothing to see')
+
+    # add the project to Platform
+    sch.add_project(project)
+
+Manage User And Group Access For Project
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Managing the project roles for a user or group is explained in the :ref:`Project Roles<project_roles>` section.
+
+Adding Users and Groups To Project
+----------------------------------
+
+After creating a project in the step above, we are now ready to add users and groups to a project.
+
+To do this you can use the following methods, :py:meth:`streamsets.sdk.sch_models.Project.add_user`
+and :py:meth:`streamsets.sdk.sch_models.Project.add_group`.
+
+You can pass one or more instances of :py:class:`streamsets.sdk.sch_models.User` or :py:class:`streamsets.sdk.sch_models.Group`
+to the respective methods to add them to a project.
+
+.. code-block:: python
+
+    # get a user to add to a project
+    user = sch.users.get(email_address="some.person@company.com")
+
+    # add the user to a project
+    project.add_user(user)
+
+    # you can add multiple users in a single call
+    project.add_user(user1, user2)
+
+    # get a group to add to a project
+    group = sch.groups.get(display_name='many-persons')
+
+    # add the group to the project
+    project.add_group(group)
+
+    # you can add multiple groups in a single call
+    project.add_group(group1, group2)
+
+Listing Users and Groups In Project
+-----------------------------------
+
+To list the users and groups in a project you can use the :py:attr:`streamsets.sdk.sch_models.Project.users` and
+:py:attr:`streamsets.sdk.sch_models.Project.groups` respectively.
+
+.. code-block:: python
+
+    # list users
+    project.users
+    # Output: [User(name=...), User(name...)]
+
+    # list groups
+    project.groups
+    # Output: [Group(display_name=...), Group(display_name=...)]
+
+Both attributes return a :py:class:`streamsets.sdk.utils.SeekableList` and it is possible to filter for users or groups based on their attributes.
+
+Removing Users and Groups From Project
+--------------------------------------
+
+To remove a user or group from a project you can use the following methods: :py:meth:`streamsets.sdk.sch_models.Project.remove_user`
+and :py:meth:`streamsets.sdk.sch_models.Project.remove_group`.
+
+You can pass one or more instances of :py:class:`streamsets.sdk.sch_models.User` or :py:class:`streamsets.sdk.sch_models.Group`
+to the respective methods to remove them from a project.
+
+.. code-block:: python
+
+    # remove a user
+    project.remove_user(user)
+
+    # remove multiple users
+    project.remove_user(user1, user2)
+
+    # remove a group
+    project.remove_group(group)
+
+    # remove multiple groups
+    project.remove_group(group1, group2)
+
+Listing Projects
+~~~~~~~~~~~~~~~~
+
+You can use the :py:attr:`streamsets.sdk.ControlHub.projects` to list all the projects in your Organization.
+This returns an instance of :py:class:`streamsets.sdk.utils.SeekableList` containing instances of
+:py:class:`streamsets.sdk.sch_models.Project`.
+
+.. code-block:: python
+
+    # list projects
+    sch.projects
+    # Output: [Project(name=..), Project(name=...)]
+
+    # get a particular project
+    project_x = sch.projects.get(name='project x')
+
+Switching Project And Organization Views
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+In the Platform UI, you start with a organization-level view by default. You can switch to a particular project's view by clicking
+on the option on the top bar of the screen and choosing which project to switch to. You can also click on the organization
+to switch back to an organization-level view.
+
+.. image:: ../../_static/images/manage/projects/switch_projects.png
+|
+
+In the SDK, we maintain a similar experience to the UI by starting with an organization-level view. We then allow the user to choose a project and switch to that project's view.
+
+This is achieved with the :py:attr:`streamsets.sdk.ControlHub.current_project` property. This property defaults to ``None``
+and can then be set to an instance of :py:class:`streamsets.sdk.sch_models.Project` to get that project's view.
+It can then be reset to ``None`` to return to an organization-level view.
+
+.. code-block:: python
+
+    # initialise a ControlHub instance
+    sch = ControlHub(...)
+
+    # the default view is always organization-level
+    sch.current_project is None
+    # Output: True
+
+    # get a project that we can switch to
+    project = sch.projects.get(name='my project')
+
+    # switch to the project view
+    sch.current_project = project
+
+    # SDK usage is the same inside a project when this attribute is set
+
+    # switch to organization-level view
+    sch.current_project = None
+
+Updating A Project
+~~~~~~~~~~~~~~~~~~
+
+Updating a project refers to updating the ``name`` and ``description`` of a project. We can do this by updating the values of those
+attributes of a :py:class:`streamsets.sdk.sch_models.Project` instance and then calling the :py:meth:`streamsets.sdk.ControlHub.update_project`
+method to update it on Platform.
+
+.. code-block:: python
+
+    # get a project to update
+    project = sch.projects.get(name='please update this name')
+
+    # set a new name or description
+    project.name = 'fantastic new name'
+    project.description = 'some description'
+
+    # update it on platform
+    sch.update_project(project)
+
+Deleting A Project
+~~~~~~~~~~~~~~~~~~
+
+A project can be deleted by passing a :py:class:`streamsets.sdk.sch_models.Project` instance to the
+:py:meth:`streamsets.sdk.ControlHub.delete_project` method.
+
+.. code-block:: python
+
+    # get a project to delete
+    project = sch.projects.get(name='delete this')
+
+    # call delete on platform
+    sch.delete_project(project)
+
+    # you can delete multiple projects at the same time
+    projects_to_delete = sch.projects.get_all(description='unused')
+    sch.delete_project(*projects_to_delete)
+
+Bringing It All Together
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+The complete scripts from this section can be found below.
+
+.. code-block:: python
+
+    # Retrieve all projects
+    sch.projects
+
+    # switching to project's view
+    project = sch.projects.get(name='some project')
+    sch.current_project = project
+
+    # switching to an organization-level view
+    sch.current_project = None
+
+    # Creating a project
+    project_builder = sch.get_project_builder()
+    project = project_builder.build(name='some name', description='optional description')
+    sch.add_project(project)
+
+    # Updating a project's name or description
+    project.name = 'new name'
+    project.description = 'new description'
+    sch.update_project(project)
+
+    # Deleting a project
+    sch.delete_project(project)
+
+    # Retrieve users/groups in a project
+    project.users
+    project.groups
+
+    # Add users/groups to a project
+    # project.add_user(user1, user2)
+    # project.add_group(group1, group2)
+
+    # Remove users/groups from a project
+    # project.remove_user(user1, user2)
+    # project.remove_group(group1, group2)

{streamsets-6.6.0.dev1 → streamsets-6.6.1rc1}/docs/manage/users_and_groups/managing_users_and_groups.rst

@@ -77,7 +77,7 @@ method:
 
     user_builder = sch.get_user_builder()
     user = user_builder.build(email_address='johndeer@test.com')
-    user.roles = ['Connection Editor', 'Connection User', 'Topology Editor', 'Topology User']
+    user.organization_roles = ['Connection Editor', 'Connection User', 'Topology Editor', 'Topology User']
     # Add user to three groups that exist in the organization: all, beta-testers, pipeline operators
     group_one = sch.groups.get(display_name='all')
     group_two = sch.groups.get(display_name='beta-testers')
@@ -87,27 +87,27 @@ method:
 
 .. note::
   The :py:meth:`streamsets.sdk.ControlHub.invite_user` method will automatically update the invited user's in-memory
-  representation, including adding the user's ``id``, ``roles``, and ``groups``.
+  representation, including adding the user's ``id``, ``organization_roles``, and ``groups``.
 
 Updating An Existing User
 -------------------------
 .. _updating_users:
 
 Updating an existing user in the UI is done by expanding the user's details, making necessary changes to attributes like
-``roles`` or ``groups``, and saving the changes:
+``organization_roles`` or ``groups``, and saving the changes:
 
 .. image:: ../../_static/images/manage/users_and_groups/update_user_details.png
 
 |
-It is also possible to update a user's attributes, like ``roles`` or ``groups``, from the SDK. Simply retrieve the user
+It is also possible to update a user's attributes, like ``organization_roles`` or ``groups``, from the SDK. Simply retrieve the user
 you wish to update, modify the desired attribute(s), and then pass the user object to the :py:meth:`streamsets.sdk.ControlHub.update_user()`
 method:
 
 .. code-block:: python
 
     user = sch.users.get(email_address='mitch@streamsets.com')
-    # Set the user's roles to be the following
-    user.roles = ['Engine Administrator', 'Job Operator', 'Pipeline Editor', 'Deployment Manager']
+    # Set the user's organization roles to be the following
+    user.organization_roles = ['Engine Administrator', 'Job Operator', 'Pipeline Editor', 'Deployment Manager']
     # Add the user to a new group
     new_group = sch.groups.get(display_name='new-group')
     user.groups.append(new_group)
@@ -208,7 +208,7 @@ example have been removed.
     # ---- Adding Users ----
     user_builder = sch.get_user_builder()
     user = user_builder.build(email_address='johndeer@test.com')
-    user.roles = ['Connection Editor', 'Connection User', 'Topology Editor', 'Topology User']
+    user.organization_roles = ['Connection Editor', 'Connection User', 'Topology Editor', 'Topology User']
     # Add user to three groups that exist in the organization: all, beta-testers, pipeline operators
     group_one = sch.groups.get(display_name='all')
     group_two = sch.groups.get(display_name='beta-testers')
@@ -218,8 +218,8 @@ example have been removed.
 
     # ---- Updating An Existing User ----
     user = sch.users.get(email_address='mitch@streamsets.com')
-    # Set the user's roles to be the following
-    user.roles = ['Engine Administrator', 'Job Operator', 'Pipeline Editor', 'Deployment Manager']
+    # Set the user's organization roles to be the following
+    user.organization_roles = ['Engine Administrator', 'Job Operator', 'Pipeline Editor', 'Deployment Manager']
     # Add the user to a new group
     new_group = sch.groups.get(display_name='new-group')
     user.groups.append(new_group)
@@ -321,7 +321,7 @@ SDK, use the :py:class:`streamsets.sdk.sch_models.GroupBuilder` class. Retrieve
     user_two = sch.users.get(email_address='kramer@streamsets.com')
     group.users = [user_one, user_two]
     # Add the 'Pipeline User' role in addition to the defaults
-    group.roles.append('Pipeline User')
+    group.organization_roles.append('Pipeline User')
     response = sch.add_group(group)
 
 .. note::
@@ -332,12 +332,12 @@ Updating Groups
 .. _updating_groups:
 
 Updating an existing group in the Platform UI is done by expanding the group's details, making necessary changes
-to attributes like ``roles`` or ``users``, and saving the changes:
+to attributes like ``organization_roles`` or ``users``, and saving the changes:
 
 .. image:: ../../_static/images/manage/users_and_groups/update_group_details.png
 
 |
-It is also possible to update a group's attributes, like ``roles`` or ``users``, from the SDK. Simply retrieve the
+It is also possible to update a group's attributes, like ``organization_roles`` or ``users``, from the SDK. Simply retrieve the
 group you wish to update, modify the desired attribute(s), and then pass the group object to the :py:meth:`streamsets.sdk.ControlHub.update_group()`
 method:
 
@@ -346,7 +346,7 @@ method:
     group = sch.groups.get(display_name='example-group')
     user_to_add = sch.users.get(email_address='constanza@streamsets.com')
     group.users.append(user_to_add)
-    group.roles.remove('Engine Administrator')
+    group.organization_roles.remove('Engine Administrator')
     response = sch.update_group(group)
 
 .. note::
@@ -403,14 +403,14 @@ example have been removed.
     user_two = sch.users.get(email_address='kramer@streamsets.com')
     group.users = [user_one, user_two]
     # Add the 'Pipeline User' role in addition to the defaults
-    group.roles.append('Pipeline User')
+    group.organization_roles.append('Pipeline User')
     response = sch.add_group(group)
 
     # ---- Updating Groups ----
     group = sch.groups.get(display_name='example-group')
     user_to_add = sch.users.get(email_address='constanza@streamsets.com')
     group.users.append(user_to_add)
-    group.roles.remove('Engine Administrator')
+    group.organization_roles.remove('Engine Administrator')
     response = sch.update_group(group)
 
     # ---- Deleting Groups ----

{streamsets-6.6.0.dev1 → streamsets-6.6.1rc1}/docs/manage/users_and_groups/permissions.rst

@@ -59,7 +59,7 @@ instance the following steps can be taken:
 .. note::
   The ``subject_id`` format for an ACL permission varies based on whether it pertains to a user or group. A user's
   ``subject_id`` will be in the format ``user.id@organization.id``, while a group's ``subject_id`` will be in the format
-  ``group.id``.
+  ``group.group_id``.
 
 
 You can inspect an ACL definition's actions to see the level of access a particular user or group has to the resource:
@@ -135,7 +135,7 @@ method to add it to the object that owns the ACL:
     # Build the new permission definition for the subject_id (id), subject_type (user or group) and the
     # actions to allow for this subject.
     user_permission = acl.permission_builder.build(subject_id=user.id, subject_type='USER', actions=actions)
-    group_permission = acl.permission_builder.build(subject_id=group.id, subject_type='GROUP', actions=actions)
+    group_permission = acl.permission_builder.build(subject_id=group.group_id, subject_type='GROUP', actions=actions)
 
     # Add the permission definition to the ACL
     acl.add_permission(user_permission)
@@ -143,7 +143,7 @@ method to add it to the object that owns the ACL:
 
     # Show that the permission definition was correctly added to the ACL
     pipeline.acl.permissions.get(subject_id=user.id)
-    pipeline.acl.permissions.get(subject_id=group.id)
+    pipeline.acl.permissions.get(subject_id=group.group_id)
 
 
 **Output:**
@@ -153,7 +153,7 @@ method to add it to the object that owns the ACL:
     # pipeline.acl.permissions.get(subject_id=user.id)
     <Permission (resource_id=b99b5d55-380d-45a5-b8f1-0c9345fb662f:791759af-e8b5-11eb-8015-e592a7dbb2d0, subject_type=USER, subject_id=aa172288-c804-11ec-ba8b-4930c98e80a9@791759af-e8b5-11eb-8015-e592a7dbb2d0)>
 
-    # pipeline.acl.permissions.get(subject_id=group.id)
+    # pipeline.acl.permissions.get(subject_id=group.group_id)
     <Permission (resource_id=b99b5d55-380d-45a5-b8f1-0c9345fb662f:791759af-e8b5-11eb-8015-e592a7dbb2d0, subject_type=GROUP, subject_id=new_group@791759af-e8b5-11eb-8015-e592a7dbb2d0)>
 
 Updating Existing ACL Permissions on an Object
@@ -170,7 +170,7 @@ the actions as needed:
 
     # Retrieve the permission definition for the subject to be modified
     group = sch.groups.get(display_name='new-group')
-    permission = pipeline.acl.permissions.get(subject_id=group.id)
+    permission = pipeline.acl.permissions.get(subject_id=group.group_id)
 
     # Create a list of new actions that the permission definition will use
     updated_actions = ['READ']
@@ -179,13 +179,13 @@ the actions as needed:
     permission.actions = updated_actions
 
     # Show that the permission definition was correctly added to the ACL
-    pipeline.acl.permissions.get(subject_id=group.id).actions
+    pipeline.acl.permissions.get(subject_id=group.group_id).actions
 
 **Output:**
 
 .. code-block:: python
 
-    # pipeline.acl.permissions.get(subject_id=group.id).actions
+    # pipeline.acl.permissions.get(subject_id=group.group_id).actions
     ['READ']
 
 .. note::