engineering/unrhodecode
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

api: user-group api docs update

Browse source
This commit is contained in:
Marcin Kuzminski 2019-07-23 12:52:10 +02:00
parent 0cb728cb99
commit 2912fa1059
1 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
rhodecode/api/views/user_group_api.py
View file

@ -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, usergroupid, group_name=Optional(''),
: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: