Skip to content

docs: document how to use sudo if modifying an object #2928

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 15, 2024
Merged

docs: document how to use sudo if modifying an object #2928

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/api-usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,6 +411,27 @@ user. For example:

p = gl.projects.create({'name': 'awesome_project'}, sudo='user1')

.. warning::
When using ``sudo``, its usage is not remembered. If you use ``sudo`` to
retrieve an object and then later use ``save()`` to modify the object, it
will not use ``sudo``. You should use ``save(sudo='user1')`` if you want to
perform subsequent actions as the user.

Updating with ``sudo``
----------------------

An example of how to ``get`` an object (using ``sudo``), modify the object, and
then ``save`` the object (using ``sudo``):

.. code-block:: python

group = gl.groups.get('example-group')
notification_setting = group.notificationsettings.get(sudo='user1')
notification_setting.level = gitlab.const.NOTIFICATION_LEVEL_GLOBAL
# Must use `sudo` again when doing the save.
notification_setting.save(sudo='user1')


Logging
=======

Expand Down