From 4fb2e439803bd55868b91827a5fbaa448f1dff56 Mon Sep 17 00:00:00 2001 From: Gauvain Pocentek Date: Sat, 4 Nov 2017 09:10:40 +0100 Subject: Add users custome attributes support --- docs/gl_objects/users.py | 18 ++++++++++++++++++ docs/gl_objects/users.rst | 36 ++++++++++++++++++++++++++++++++++++ 2 files changed, 54 insertions(+) (limited to 'docs/gl_objects') 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 ============ -- cgit v1.2.1