summaryrefslogtreecommitdiff
path: root/docs/gl_objects
diff options
context:
space:
mode:
authorAbhishek Singh <abhiandthetruth@gmail.com>2022-11-22 04:44:47 +0530
committerGitHub <noreply@github.com>2022-11-22 00:14:47 +0100
commit1020ce965ff0cd3bfc283d4f0ad40e41e4d1bcee (patch)
tree1e3be865297737f5b147d26ec3a05ae6ef8d19d7 /docs/gl_objects
parent65abb85be7fc8ef57b295296111dac0a97ed1c49 (diff)
downloadgitlab-1020ce965ff0cd3bfc283d4f0ad40e41e4d1bcee.tar.gz
feat: add support for SAML group links (#2367)
Diffstat (limited to 'docs/gl_objects')
-rw-r--r--docs/gl_objects/groups.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/gl_objects/groups.rst b/docs/gl_objects/groups.rst
index 98f0bee..fafa40a 100644
--- a/docs/gl_objects/groups.rst
+++ b/docs/gl_objects/groups.rst
@@ -358,6 +358,28 @@ You can use the ``ldapgroups`` manager to list available LDAP groups::
# list the groups for a specific LDAP provider
ldap_groups = gl.ldapgroups.list(search='foo', provider='ldapmain')
+SAML group links
+================
+
+Add a SAML group link to an existing GitLab group::
+
+ saml_link = group.saml_group_links.create({
+ "saml_group_name": "<your_saml_group_name>",
+ "access_level": <chosen_access_level>
+ })
+
+List a group's SAML group links::
+
+ group.saml_group_links.list()
+
+Get a SAML group link::
+
+ group.saml_group_links.get("<your_saml_group_name>")
+
+Remove a link::
+
+ saml_link.delete()
+
Groups hooks
============