Users and current user

The Gitlab API exposes user-related method that can be manipulated by adminsonly.

The currently logged-in user is also exposed.

Users

References

Examples

Get the list of users:

users=gl.users.list()

Search users whose username match a given string:

users=gl.users.list(search='foo')

Get a single user:

# by IDuser=gl.users.get(user_id)# by usernameuser=gl.users.list(username='root')[0]

Create a user:

user=gl.users.create({'email':'john@doe.com','password':'s3cur3s3cr3T','username':'jdoe','name':'John Doe'})

Update a user:

user.name='Real Name'user.save()

Delete a user:

gl.users.delete(user_id)# oruser.delete()

Block/Unblock a user:

user.block()user.unblock()

Activate/Deactivate a user:

user.activate()user.deactivate()

Follow/Unfollow a user:

user.follow()user.unfollow()

Set the avatar image for a user:

# the avatar image can be passed as data (content of the file) or as a file# object opened in binary modeuser.avatar=open('path/to/file.png','rb')user.save()

Set an external identity for a user:

user.provider='oauth2_generic'user.extern_uid='3'user.save()

Delete an external identity by provider name:

user.identityproviders.delete('oauth2_generic')

Get the followers of a user

user.followers_users.list()

Get the followings of a user

user.following_users.list()

User custom attributes

References

Examples

List custom attributes for a user:

attrs=user.customattributes.list()

Get a custom attribute for a user:

attr=user.customattributes.get(attr_key)

Set (create or update) a custom attribute for a user:

attr=user.customattributes.set(attr_key,attr_value)

Delete a custom attribute for a user:

attr.delete()# oruser.customattributes.delete(attr_key)

Search users by custom attribute:

user.customattributes.set('role','QA')gl.users.list(custom_attributes={'role':'QA'})

User impersonation tokens

References

List impersonation tokens for a user:

i_t=user.impersonationtokens.list(state='active')i_t=user.impersonationtokens.list(state='inactive')

Get an impersonation token for a user:

i_t=user.impersonationtokens.get(i_t_id)

Create and use an impersonation token for a user:

i_t=user.impersonationtokens.create({'name':'token1','scopes':['api']})# use the token to create a new gitlab connectionuser_gl=gitlab.Gitlab(gitlab_url,private_token=i_t.token)

Revoke (delete) an impersonation token for a user:

i_t.delete()

User memberships

References

List direct memberships for a user:

memberships=user.memberships.list()

List only direct project memberships:

memberships=user.memberships.list(type='Project')

List only direct group memberships:

memberships=user.memberships.list(type='Namespace')

Current User

References

Examples

Get the current user:

gl.auth()current_user=gl.user

GPG keys

References

You can manipulate GPG keys for the current user and for the other users if youare admin.

Examples

List GPG keys for a user:

gpgkeys=user.gpgkeys.list()

Get a GPG gpgkey for a user:

gpgkey=user.gpgkeys.get(key_id)

Create a GPG gpgkey for a user:

# get the key with `gpg --export -a GPG_KEY_ID`k=user.gpgkeys.create({'key':public_key_content})

Delete a GPG gpgkey for a user:

user.gpgkeys.delete(key_id)# orgpgkey.delete()

SSH keys

References

You can manipulate SSH keys for the current user and for the other users if youare admin.

Examples

List SSH keys for a user:

keys=user.keys.list()

Create an SSH key for a user:

k=user.keys.create({'title':'my_key','key':open('/home/me/.ssh/id_rsa.pub').read()})

Delete an SSH key for a user:

user.keys.delete(key_id)# orkey.delete()

Status

References

You can manipulate the status for the current user and you can read the status of other users.

Examples

Get current user status:

status=user.status.get()

Update the status for the current user:

status=user.status.get()status.message="message"status.emoji="thumbsup"status.save()

Get the status of other users:

gl.users.get(1).status.get()

Emails

References

You can manipulate emails for the current user and for the other users if youare admin.

Examples

List emails for a user:

emails=user.emails.list()

Get an email for a user:

email=user.emails.get(email_id)

Create an email for a user:

k=user.emails.create({'email':'foo@bar.com'})

Delete an email for a user:

user.emails.delete(email_id)# oremail.delete()

Users activities

References

Examples

Get the users activities:

activities=gl.user_activities.list(query_parameters={'from':'2018-07-01'},all=True,as_list=False)