# HG changeset patch # User Marcin Kuzminski # Date 2019-07-23 10:52:10 # Node ID d2ea15f3261e4b3cd2b876b2114b2483f937661e # Parent a4fb81bb1c88ccc080659d25f42368c626592fc0 api: user-group api docs update diff --git a/rhodecode/api/views/user_group_api.py b/rhodecode/api/views/user_group_api.py --- a/rhodecode/api/views/user_group_api.py +++ b/rhodecode/api/views/user_group_api.py @@ -190,7 +190,9 @@ def create_user_group( :param active: Set this group as active. :type active: Optional(``True`` | ``False``) :param sync: Set enabled or disabled the automatically sync from - external authentication types like ldap. + external authentication types like ldap. If User Group will be named like + one from e.g ldap and sync flag is enabled members will be synced automatically. + Sync type when enabled via API is set to `manual_api` :type sync: Optional(``True`` | ``False``) Example output: @@ -298,7 +300,9 @@ def update_user_group(request, apiuser, :param active: Set the group as active. :type active: Optional(``True`` | ``False``) :param sync: Set enabled or disabled the automatically sync from - external authentication types like ldap. + external authentication types like ldap. If User Group will be named like + one from e.g ldap and sync flag is enabled members will be synced automatically. + Sync type when enabled via API is set to `manual_api` :type sync: Optional(``True`` | ``False``) Example output: