Package org.gitlab4j.api

Class UserApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.UserApi

All Implemented Interfaces:

Constants

public class UserApi
extends AbstractApi

This class provides an entry point to all the GitLab API users calls.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gitlab4j.api.Constants

Constants.ActionType, Constants.EpicOrderBy, Constants.GroupOrderBy, Constants.ImpersonationState, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.MergeRequestOrderBy, Constants.MergeRequestScope, Constants.MergeRequestState, Constants.MilestoneState, Constants.PipelineOrderBy, Constants.PipelineScope, Constants.ProjectOrderBy, Constants.SortOrder, Constants.StateEvent, Constants.TargetType, Constants.TokenType

Field Summary

Fields inherited from interface org.gitlab4j.api.Constants

NEXT_PAGE_HEADER, PAGE_HEADER, PAGE_PARAM, PER_PAGE, PER_PAGE_PARAM, PREV_PAGE_HEADER, TOTAL_HEADER, TOTAL_PAGES_HEADER

Method Summary

Modifier and Type	Method	Description
SshKey	addSshKey(Integer userId, String title, String key)	Create new key owned by specified user.
SshKey	addSshKey(String title, String key)	Creates a new key owned by the currently authenticated user.
void	blockUser(Integer userId)	Blocks the specified user.
ImpersonationToken	createImpersonationToken(Integer userId, String name, Date expiresAt, ImpersonationToken.Scope[] scopes)	Create an impersonation token.
User	createUser(User user, CharSequence password, boolean resetPassword)	Creates a new user.
User	createUser(User user, CharSequence password, Integer projectsLimit)	Deprecated. Will be removed in version 5.0, replaced by createUser(User, CharSequence, boolean)
void	deleteSshKey(Integer keyId)	Deletes key owned by currently authenticated user.
void	deleteSshKey(Integer userId, Integer keyId)	Deletes key owned by a specified user.
void	deleteUser(Integer userId)	Deletes a user.
void	deleteUser(Integer userId, Boolean hardDelete)	Deletes a user.
void	deleteUser(User user)	Deletes a user.
void	deleteUser(User user, Boolean hardDelete)	Deletes a user.
List<User>	findUsers(String emailOrUsername)	Search users by Email or username GET /users?search=:email_or_username
Pager<User>	findUsers(String emailOrUsername, int itemsPerPage)	Search users by Email or username and return a Pager GET /users?search=:email_or_username
List<User>	findUsers(String emailOrUsername, int page, int perPage)	Search users by Email or username in the specified page range.
List<User>	getActiveUsers()	Get a list of active users.
Pager<User>	getActiveUsers(int itemsPerPage)	Get a Pager of active users.
List<User>	getActiveUsers(int page, int perPage)	Get a list of active users using the specified page and per page settings.
List<User>	getblockedUsers(int page, int perPage)	Get a list of blocked users using the specified page and per page settings.
List<User>	getBlockedUsers()	Get a list of blocked users.
Pager<User>	getBlockedUsers(int itemsPerPage)	Get a Pager of blocked users.
User	getCurrentUser()	Get currently authenticated user.
ImpersonationToken	getImpersonationToken(Integer userId, Integer tokenId)	Get an impersonation token of a user.
List<ImpersonationToken>	getImpersonationTokens(Integer userId)	Get a list of a specified user's impersonation tokens.
List<ImpersonationToken>	getImpersonationTokens(Integer userId, Constants.ImpersonationState state)	Get a list of a specified user's impersonation tokens.
Optional<ImpersonationToken>	getOptionalImpersonationToken(Integer userId, Integer tokenId)	Get an impersonation token of a user as an Optional instance.
Optional<SshKey>	getOptionalSshKey(Integer keyId)	Get a single SSH Key as an Optional instance.
Optional<User>	getOptionalUser(int userId)	Get a single user as an Optional instance.
Optional<User>	getOptionalUser(String username)	Lookup a user by username and return an Optional instance.
SshKey	getSshKey(Integer keyId)	Get a single SSH Key.
List<SshKey>	getSshKeys()	Get a list of currently authenticated user's SSH keys.
List<SshKey>	getSshKeys(Integer userId)	Get a list of a specified user's SSH keys.
User	getUser(int userId)	Get a single user.
User	getUser(String username)	Lookup a user by username.
List<User>	getUsers()	Get a list of users.
Pager<User>	getUsers(int itemsPerPage)	Get a Pager of users.
List<User>	getUsers(int page, int perPage)	Get a list of users using the specified page and per page settings.
User	modifyUser(User user, CharSequence password, Integer projectsLimit)	Deprecated. Will be removed in version 5.0, replaced by updateUser(User, CharSequence)
void	revokeImpersonationToken(Integer userId, Integer tokenId)	Revokes an impersonation token.
void	unblockUser(Integer userId)	Unblocks the specified user.
User	updateUser(User user, CharSequence password)	Modifies an existing user.

Methods inherited from class org.gitlab4j.api.AbstractApi

addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getGroupIdOrPath, getPageQueryParams, getProjectIdOrPath, getWithAccepts, handle, isApiVersion, post, post, post, post, post, put, put, putWithFormData, upload, upload, urlEncode, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getUsers

public List<User> getUsers()
                    throws GitLabApiException

Get a list of users. Only returns the first page GET /users

Returns:

a list of Users, this list will only contain the first 100 users in the system.

Throws:

GitLabApiException - if any exception occurs

getUsers

public List<User> getUsers(int page,
                           int perPage)
                    throws GitLabApiException

Get a list of users using the specified page and per page settings. GET /users

Parameters:

page - the page to get

perPage - the number of users per page

Returns:

the list of Users in the specified range

Throws:

GitLabApiException - if any exception occurs

getUsers

public Pager<User> getUsers(int itemsPerPage)
                     throws GitLabApiException

Get a Pager of users. GET /users

Parameters:

itemsPerPage - the number of User instances that will be fetched per page

Returns:

a Pager of User

Throws:

GitLabApiException - if any exception occurs

getActiveUsers

public List<User> getActiveUsers()
                          throws GitLabApiException

Get a list of active users. Only returns the first page GET /users?active=true

Returns:

a list of active Users, this list will only contain the first 100 users in the system.

Throws:

GitLabApiException - if any exception occurs

getActiveUsers

public List<User> getActiveUsers(int page,
                                 int perPage)
                          throws GitLabApiException

Get a list of active users using the specified page and per page settings. GET /users?active=true

Parameters:

page - the page to get

perPage - the number of users per page

Returns:

the list of active Users in the specified range

Throws:

GitLabApiException - if any exception occurs

getActiveUsers

public Pager<User> getActiveUsers(int itemsPerPage)
                           throws GitLabApiException

Get a Pager of active users. GET /users?active=true

Parameters:

itemsPerPage - the number of active User instances that will be fetched per page

Returns:

a Pager of active User

Throws:

GitLabApiException - if any exception occurs

blockUser

public void blockUser(Integer userId)
               throws GitLabApiException

Blocks the specified user. Available only for admin. POST /users/:id/block

Parameters:

userId - the ID of the user to block

Throws:

GitLabApiException - if any exception occurs

unblockUser

public void unblockUser(Integer userId)
                 throws GitLabApiException

Unblocks the specified user. Available only for admin. POST /users/:id/unblock

Parameters:

userId - the ID of the user to unblock

Throws:

GitLabApiException - if any exception occurs

getBlockedUsers

public List<User> getBlockedUsers()
                           throws GitLabApiException

Get a list of blocked users. Only returns the first page GET /users?blocked=true

Returns:

a list of blocked Users, this list will only contain the first 100 users in the system.

Throws:

GitLabApiException - if any exception occurs

getblockedUsers

public List<User> getblockedUsers(int page,
                                  int perPage)
                           throws GitLabApiException

Get a list of blocked users using the specified page and per page settings. GET /users?blocked=true

Parameters:

page - the page to get

perPage - the number of users per page

Returns:

the list of blocked Users in the specified range

Throws:

GitLabApiException - if any exception occurs

getBlockedUsers

public Pager<User> getBlockedUsers(int itemsPerPage)
                            throws GitLabApiException

Get a Pager of blocked users. GET /users?blocked=true

Parameters:

itemsPerPage - the number of blocked User instances that will be fetched per page

Returns:

a Pager of blocked User

Throws:

GitLabApiException - if any exception occurs

getUser

public User getUser(int userId)
             throws GitLabApiException

Get a single user. GET /users/:id

Parameters:

userId - the ID of the user to get

Returns:

the User instance for the specified user ID

Throws:

GitLabApiException - if any exception occurs

getOptionalUser

public Optional<User> getOptionalUser(int userId)

Get a single user as an Optional instance. GET /users/:id

Parameters:

userId - the ID of the user to get

Returns:

the User for the specified user ID as an Optional instance

getUser

public User getUser(String username)
             throws GitLabApiException

Lookup a user by username. NOTE: This is for admin users only. GET /users?username=:username

Parameters:

username - the username of the user to get

Returns:

the User instance for the specified username

Throws:

GitLabApiException - if any exception occurs

getOptionalUser

public Optional<User> getOptionalUser(String username)

Lookup a user by username and return an Optional instance. NOTE: This is for admin users only. GET /users?username=:username

Parameters:

username - the username of the user to get

Returns:

the User for the specified username as an Optional instance

findUsers

public List<User> findUsers(String emailOrUsername)
                     throws GitLabApiException

Search users by Email or username GET /users?search=:email_or_username

Parameters:

emailOrUsername - the email or username to search for

Returns:

the User List with the email or username like emailOrUsername

Throws:

GitLabApiException - if any exception occurs

findUsers

public List<User> findUsers(String emailOrUsername,
                            int page,
                            int perPage)
                     throws GitLabApiException

Search users by Email or username in the specified page range. GET /users?search=:email_or_username

Parameters:

emailOrUsername - the email or username to search for

page - the page to get

perPage - the number of users per page

Returns:

the User List with the email or username like emailOrUsername in the specified page range

Throws:

GitLabApiException - if any exception occurs

findUsers

public Pager<User> findUsers(String emailOrUsername,
                             int itemsPerPage)
                      throws GitLabApiException

Search users by Email or username and return a Pager GET /users?search=:email_or_username

Parameters:

emailOrUsername - the email or username to search for

itemsPerPage - the number of Project instances that will be fetched per page

Returns:

the User Pager with the email or username like emailOrUsername

Throws:

GitLabApiException - if any exception occurs

createUser

public User createUser(User user,
                       CharSequence password,
                       Integer projectsLimit)
                throws GitLabApiException

Deprecated. Will be removed in version 5.0, replaced by createUser(User, CharSequence, boolean)

Creates a new user. Note only administrators can create new users. Either password or reset_password should be specified (reset_password takes priority). If both the User object's projectsLimit and the parameter projectsLimit is specified the parameter will take precedence.

POST /users

The following properties of the provided User instance can be set during creation:

 email (required) - Email
 username (required) - Username
 name (required) - Name
 skype (optional) - Skype ID
 linkedin (optional) - LinkedIn
 twitter (optional) - Twitter account
 websiteUrl (optional) - Website URL
 organization (optional) - Organization name
 projectsLimit (optional) - Number of projects user can create
 externUid (optional) - External UID
 provider (optional) - External provider name
 bio (optional) - User's biography
 location (optional) - User's location
 admin (optional) - User is admin - true or false (default)
 canCreateGroup (optional) - User can create groups - true or false
 skipConfirmation (optional) - Skip confirmation - true or false (default)
 external (optional) - Flags the user as external - true or false(default)
 sharedRunnersMinutesLimit (optional) - Pipeline minutes quota for this user

Parameters:

user - the User instance with the user info to create

password - the password for the new user

projectsLimit - the maximum number of project

Returns:

created User instance

Throws:

GitLabApiException - if any exception occurs

createUser

public User createUser(User user,
                       CharSequence password,
                       boolean resetPassword)
                throws GitLabApiException

Creates a new user. Note only administrators can create new users. Either password or resetPassword should be specified (resetPassword takes priority).

POST /users

The following properties of the provided User instance can be set during creation:

 email (required) - Email
 username (required) - Username
 name (required) - Name
 skype (optional) - Skype ID
 linkedin (optional) - LinkedIn
 twitter (optional) - Twitter account
 websiteUrl (optional) - Website URL
 organization (optional) - Organization name
 projectsLimit (optional) - Number of projects user can create
 externUid (optional) - External UID
 provider (optional) - External provider name
 bio (optional) - User's biography
 location (optional) - User's location
 admin (optional) - User is admin - true or false (default)
 canCreateGroup (optional) - User can create groups - true or false
 skipConfirmation (optional) - Skip confirmation - true or false (default)
 external (optional) - Flags the user as external - true or false(default)
 sharedRunnersMinutesLimit (optional) - Pipeline minutes quota for this user

Parameters:

user - the User instance with the user info to create

password - the password for the new user

resetPassword - whether to send a password reset link

Returns:

created User instance

Throws:

GitLabApiException - if any exception occurs

updateUser

public User updateUser(User user,
                       CharSequence password)
                throws GitLabApiException

Modifies an existing user. Only administrators can change attributes of a user.

PUT /users

The following properties of the provided User instance can be set during update:

 email (required) - Email
 username (required) - Username
 name (required) - Name
 skype (optional) - Skype ID
 linkedin (optional) - LinkedIn
 twitter (optional) - Twitter account
 websiteUrl (optional) - Website URL
 organization (optional) - Organization name
 projectsLimit (optional) - Number of projects user can create
 externUid (optional) - External UID
 provider (optional) - External provider name
 bio (optional) - User's biography
 location (optional) - User's location
 admin (optional) - User is admin - true or false (default)
 canCreateGroup (optional) - User can create groups - true or false
 skipConfirmation (optional) - Skip confirmation - true or false (default)
 external (optional) - Flags the user as external - true or false(default)
 sharedRunnersMinutesLimit (optional) - Pipeline minutes quota for this user

Parameters:

user - the User instance with the user info to modify

password - the new password for the user

Returns:

the modified User instance

Throws:

GitLabApiException - if any exception occurs

modifyUser

@Deprecated
public User modifyUser(User user,
                       CharSequence password,
                       Integer projectsLimit)
                throws GitLabApiException

Deprecated. Will be removed in version 5.0, replaced by updateUser(User, CharSequence)

Modifies an existing user. Only administrators can change attributes of a user.

PUT /users/:id

The following properties of the provided User instance can be set during update:

 email (required) - Email
 username (required) - Username
 name (required) - Name
 skype (optional) - Skype ID
 linkedin (optional) - LinkedIn
 twitter (optional) - Twitter account
 websiteUrl (optional) - Website URL
 organization (optional) - Organization name
 projectsLimit (optional) - Number of projects user can create
 externUid (optional) - External UID
 provider (optional) - External provider name
 bio (optional) - User's biography
 location (optional) - User's location
 admin (optional) - User is admin - true or false (default)
 canCreateGroup (optional) - User can create groups - true or false
 skipConfirmation (optional) - Skip confirmation - true or false (default)
 external (optional) - Flags the user as external - true or false(default)
 sharedRunnersMinutesLimit (optional) - Pipeline minutes quota for this user

Parameters:

user - the User instance with the user info to modify

password - the new password for the user

projectsLimit - the maximum number of project

Returns:

the modified User instance

Throws:

GitLabApiException - if any exception occurs

deleteUser

public void deleteUser(Integer userId)
                throws GitLabApiException

Deletes a user. Available only for administrators. DELETE /users/:id

Parameters:

userId - the user ID to delete

Throws:

GitLabApiException - if any exception occurs

deleteUser

public void deleteUser(Integer userId,
                       Boolean hardDelete)
                throws GitLabApiException

Deletes a user. Available only for administrators. DELETE /users/:id

Parameters:

userId - the user ID to delete

hardDelete - If true, contributions that would usually be moved to the ghost user will be deleted instead, as well as groups owned solely by this user

Throws:

GitLabApiException - if any exception occurs

deleteUser

public void deleteUser(User user)
                throws GitLabApiException

Deletes a user. Available only for administrators. DELETE /users/:id

Parameters:

user - the User instance to delete

Throws:

GitLabApiException - if any exception occurs

deleteUser

public void deleteUser(User user,
                       Boolean hardDelete)
                throws GitLabApiException

Deletes a user. Available only for administrators. DELETE /users/:id

Parameters:

user - the User instance to delete

hardDelete - If true, contributions that would usually be moved to the ghost user will be deleted instead, as well as groups owned solely by this user

Throws:

GitLabApiException - if any exception occurs

getCurrentUser

public User getCurrentUser()
                    throws GitLabApiException

Get currently authenticated user. GET /user

Returns:

the User instance for the currently authenticated user

Throws:

GitLabApiException - if any exception occurs

getSshKeys

public List<SshKey> getSshKeys()
                        throws GitLabApiException

Get a list of currently authenticated user's SSH keys. GET /user/keys

Returns:

a list of currently authenticated user's SSH keys

Throws:

GitLabApiException - if any exception occurs

getSshKeys

public List<SshKey> getSshKeys(Integer userId)
                        throws GitLabApiException

Get a list of a specified user's SSH keys. Available only for admin users. GET /users/:id/keys

Parameters:

userId - the ID of the user to get SSH keys for

Returns:

a list of a specified user's SSH keys

Throws:

GitLabApiException - if any exception occurs

getSshKey

public SshKey getSshKey(Integer keyId)
                 throws GitLabApiException

Get a single SSH Key. GET /user/keys/:key_id

Parameters:

keyId - the ID of the SSH key.

Returns:

an SshKey instance holding the info on the SSH key specified by keyId

Throws:

GitLabApiException - if any exception occurs

getOptionalSshKey

public Optional<SshKey> getOptionalSshKey(Integer keyId)

Get a single SSH Key as an Optional instance. GET /user/keys/:key_id

Parameters:

keyId - the ID of the SSH key

Returns:

an SshKey as an Optional instance holding the info on the SSH key specified by keyId

addSshKey

public SshKey addSshKey(String title,
                        String key)
                 throws GitLabApiException

Creates a new key owned by the currently authenticated user. POST /user/keys

Parameters:

title - the new SSH Key's title

key - the new SSH key

Returns:

an SshKey instance with info on the added SSH key

Throws:

GitLabApiException - if any exception occurs

addSshKey

public SshKey addSshKey(Integer userId,
                        String title,
                        String key)
                 throws GitLabApiException

Create new key owned by specified user. Available only for admin users. POST /users/:id/keys

Parameters:

userId - the ID of the user to add the SSH key for

title - the new SSH Key's title

key - the new SSH key

Returns:

an SshKey instance with info on the added SSH key

Throws:

GitLabApiException - if any exception occurs

deleteSshKey

public void deleteSshKey(Integer keyId)
                  throws GitLabApiException

Deletes key owned by currently authenticated user. This is an idempotent function and calling it on a key that is already deleted or not available results in success. DELETE /user/keys/:key_id

Parameters:

keyId - the key ID to delete

Throws:

GitLabApiException - if any exception occurs

deleteSshKey

public void deleteSshKey(Integer userId,
                         Integer keyId)
                  throws GitLabApiException

Deletes key owned by a specified user. Available only for admin users. DELETE /users/:id/keys/:key_id

Parameters:

userId - the user ID of the user to delete the key for

keyId - the key ID to delete

Throws:

GitLabApiException - if any exception occurs

getImpersonationTokens

public List<ImpersonationToken> getImpersonationTokens(Integer userId)
                                                throws GitLabApiException

Get a list of a specified user's impersonation tokens. Available only for admin users. GET /users/:id/impersonation_tokens

Parameters:

userId - the ID of the user to get impersonation tokens for

Returns:

a list of a specified user's impersonation tokens

Throws:

GitLabApiException - if any exception occurs

getImpersonationTokens

public List<ImpersonationToken> getImpersonationTokens(Integer userId,
                                                       Constants.ImpersonationState state)
                                                throws GitLabApiException

Get a list of a specified user's impersonation tokens. Available only for admin users. GET /users/:id/impersonation_tokens

Parameters:

userId - the ID of the user to get impersonation tokens for

state - the state of impersonation tokens to list (ALL, ACTIVE, INACTIVE)

Returns:

a list of a specified user's impersonation tokens

Throws:

GitLabApiException - if any exception occurs

getImpersonationToken

public ImpersonationToken getImpersonationToken(Integer userId,
                                                Integer tokenId)
                                         throws GitLabApiException

Get an impersonation token of a user. Available only for admin users. GET /users/:user_id/impersonation_tokens/:impersonation_token_id

Parameters:

userId - the ID of the user to get SSH keys for

tokenId - the impersonation token ID to get

Returns:

the specified impersonation token

Throws:

GitLabApiException - if any exception occurs

getOptionalImpersonationToken

public Optional<ImpersonationToken> getOptionalImpersonationToken(Integer userId,
                                                                  Integer tokenId)

Get an impersonation token of a user as an Optional instance. Available only for admin users. GET /users/:user_id/impersonation_tokens/:impersonation_token_id

Parameters:

userId - the ID of the user to get SSH keys for

tokenId - the impersonation token ID to get

Returns:

the specified impersonation token as an Optional instance

createImpersonationToken

public ImpersonationToken createImpersonationToken(Integer userId,
                                                   String name,
                                                   Date expiresAt,
                                                   ImpersonationToken.Scope[] scopes)
                                            throws GitLabApiException

Create an impersonation token. Available only for admin users. POST /users/:user_id/impersonation_tokens

Parameters:

userId - the ID of the user to get SSH keys for

name - the name of the impersonation token, required

expiresAt - the expiration date of the impersonation token, optional

scopes - an array of scopes of the impersonation token

Returns:

the created ImpersonationToken instance

Throws:

GitLabApiException - if any exception occurs

revokeImpersonationToken

public void revokeImpersonationToken(Integer userId,
                                     Integer tokenId)
                              throws GitLabApiException

Revokes an impersonation token. Available only for admin users. DELETE /users/:user_id/impersonation_tokens/:impersonation_token_id

Parameters:

userId - the user ID of the user to revoke the impersonation token for

tokenId - the impersonation token ID to revoke

Throws:

GitLabApiException - if any exception occurs