summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2017-11-04 09:10:40 +0100
committerGauvain Pocentek <gauvain@pocentek.net>2017-11-04 09:10:40 +0100
commit4fb2e439803bd55868b91827a5fbaa448f1dff56 (patch)
treed34db7c329b2d9e1a684fb1d7429014c9500d317 /docs
parent32f7e17208987fa345670421c333e22ae6aced6a (diff)
downloadgitlab-4fb2e439803bd55868b91827a5fbaa448f1dff56.tar.gz
Add users custome attributes support
Diffstat (limited to 'docs')
-rw-r--r--docs/gl_objects/users.py18
-rw-r--r--docs/gl_objects/users.rst36
2 files changed, 54 insertions, 0 deletions
diff --git a/docs/gl_objects/users.py b/docs/gl_objects/users.py
index c3618b9..da516e6 100644
--- a/docs/gl_objects/users.py
+++ b/docs/gl_objects/users.py
@@ -97,3 +97,21 @@ email.delete()
gl.auth()
current_user = gl.user
# end currentuser get
+
+# ca list
+attrs = user.customeattributes.list()
+# end ca list
+
+# ca get
+attr = user.customeattributes.get(attr_key)
+# end ca get
+
+# ca set
+attr = user.customeattributes.set(attr_key, attr_value)
+# end ca set
+
+# ca delete
+attr.delete()
+# or
+user.customeattributes.delete(attr_key)
+# end ca delete
diff --git a/docs/gl_objects/users.rst b/docs/gl_objects/users.rst
index d5b2976..4e22491 100644
--- a/docs/gl_objects/users.rst
+++ b/docs/gl_objects/users.rst
@@ -70,6 +70,42 @@ Block/Unblock a user:
:start-after: # block
:end-before: # end block
+User custom attributes
+======================
+
+References
+----------
+
+* v4 API:
+
+ + :class:`gitlab.v4.objects.UserCustomAttribute`
+ + :class:`gitlab.v4.objects.UserCustomAttributeManager`
+ + :attr:`gitlab.v4.objects.User.customattributes`
+
+List custom attributes for a user:
+
+.. literalinclude:: users.py
+ :start-after: # ca list
+ :end-before: # end ca list
+
+Get a custom attribute for a user:
+
+.. literalinclude:: users.py
+ :start-after: # ca get
+ :end-before: # end ca get
+
+Set (create or update) a custom attribute for a user:
+
+.. literalinclude:: users.py
+ :start-after: # ca set
+ :end-before: # end ca set
+
+Delete a custom attribute for a user:
+
+.. literalinclude:: users.py
+ :start-after: # ca list
+ :end-before: # end ca list
+
Current User
============