diff options
| author | Gauvain Pocentek <gauvain@pocentek.net> | 2018-06-13 22:01:48 +0200 |
|---|---|---|
| committer | Gauvain Pocentek <gauvain@pocentek.net> | 2018-06-13 22:01:48 +0200 |
| commit | ebf822cef7e686d8a198dcf419c20b1bfb88dea3 (patch) | |
| tree | cedd504652d23863f6e7350805cec15cbd75842d /docs | |
| parent | 5183069722224914bd6c2d25996163861183415b (diff) | |
| download | gitlab-ebf822cef7e686d8a198dcf419c20b1bfb88dea3.tar.gz | |
Add support for the LDAP gorups API
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/gl_objects/groups.rst | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/docs/gl_objects/groups.rst b/docs/gl_objects/groups.rst index 9eddcd9..5ef5469 100644 --- a/docs/gl_objects/groups.rst +++ b/docs/gl_objects/groups.rst @@ -177,12 +177,23 @@ LDAP group links Add an LDAP group link to an existing GitLab group:: - group.add_ldap_group_link(ldap_group_cn, gitlab.DEVELOPER_ACCESS, 'main') + group.add_ldap_group_link(ldap_group_cn, gitlab.DEVELOPER_ACCESS, 'ldapmain') Remove a link:: - group.delete_ldap_group_link(ldap_group_cn, 'main') + group.delete_ldap_group_link(ldap_group_cn, 'ldapmain') Sync the LDAP groups:: group.ldap_sync() + +You can use the ``ldapgroups`` manager to list available LDAP groups:: + + # listing (supports pagination) + ldap_groups = gl.ldapgroups.list() + + # filter using a group name + ldap_groups = gl.ldapgroups.list(search='foo') + + # list the groups for a specific LDAP provider + ldap_groups = gl.ldapgroups.list(search='foo', provider='ldapmain') |