summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNejc Habjan <nejc.habjan@siemens.com>2022-11-17 18:19:29 +0100
committerJohn Villalovos <john@sodarock.com>2022-11-17 14:46:04 -0800
commit3a61f601adaec7751cdcfbbcb88aa544326b1730 (patch)
tree3f44d745dd12830402e4259b3a62ab3c5e46df80 /docs
parent0c98b2d8f4b8c1ac6a4b496282f307687b652759 (diff)
downloadgitlab-3a61f601adaec7751cdcfbbcb88aa544326b1730.tar.gz
feat(groups): add LDAP link manager and deprecate old API endpoints
Diffstat (limited to 'docs')
-rw-r--r--docs/gl_objects/groups.rst15
1 files changed, 13 insertions, 2 deletions
diff --git a/docs/gl_objects/groups.rst b/docs/gl_objects/groups.rst
index 4a01253..98f0bee 100644
--- a/docs/gl_objects/groups.rst
+++ b/docs/gl_objects/groups.rst
@@ -326,11 +326,22 @@ LDAP group links
Add an LDAP group link to an existing GitLab group::
- group.add_ldap_group_link(ldap_group_cn, gitlab.const.AccessLevel.DEVELOPER, 'ldapmain')
+ ldap_link = group.ldap_group_links.create({
+ 'provider': 'ldapmain',
+ 'group_access': gitlab.const.AccessLevel.DEVELOPER,
+ 'cn: 'ldap_group_cn'
+ })
+
+List a group's LDAP group links:
+
+ group.ldap_group_links.list()
Remove a link::
- group.delete_ldap_group_link(ldap_group_cn, 'ldapmain')
+ ldap_link.delete()
+ # or by explicitly providing the CN or filter
+ group.ldap_group_links.delete(provider='ldapmain', cn='ldap_group_cn')
+ group.ldap_group_links.delete(provider='ldapmain', filter='(cn=Common Name)')
Sync the LDAP groups::