GitLab Endpoint: GET /groupsGitLab Endpoint: GET /groupsGitLab Endpoint: GET /groupsGitLab Endpoint: GET /groupsGET /groups/:id/subgroups
GitLab Endpoint: GET /groups/:id/subgroupsGitLab Endpoint: GET /groups/:id/subgroupsGitLab Endpoint: GET /groups/:id/subgroupsGET /groups/:id/subgroups
GitLab Endpoint: GET /groups/:id/subgroupsGET /groups/:id/subgroups
GitLab Endpoint: GET /groups/:id/subgroupsGET /groups/:id/subgroups
GET /groups/:id/subgroups
GitLab Endpoint: GET /groups/:id/subgroupsGitLab Endpoint: GET /groups/:id/subgroupsGitLab Endpoint: GET /groups/:id/projectsGitLab Endpoint: GET /groups/:id/projectsGitLab Endpoint: GET /groups/:id/projectsGitLab Endpoint: GET /groups/:id/projectsGitLab Endpoint: GET /groups/:id/projectsGitLab Endpoint: GET /groups/:id/projectsGitLab Endpoint: GET /groups/:id/projectsGitLab Endpoint: GET /groups/:idGitLab Endpoint: GET /groups/:idGitLab Endpoint: POST /groupsGitLab Endpoint: POST /groupsGitLab Endpoint: PUT /groupsGitLab Endpoint: PUT /groupsGitLab Endpoint: POST /groupsGitLab Endpoint: PUT /groupsGitLab Endpoint: DELETE /groups/:idGitLab Endpoint: GET /groups/:id/membersGitLab Endpoint: GET /groups/:id/membersGitLab Endpoint: GET /groups/:id/membersGitLab Endpoint: GET /groups/:id/membersGitLab Endpoint: GET /groups/:id/members/:idGitLab Endpoint: GET /groups/:id/members/:idGitLab Endpoint: POST /groups/:id/membersGitLab Endpoint: POST /groups/:id/membersGitLab Endpoint: POST /groups/:id/membersGitLab Endpoint: POST /groups/:id/membersGitLab Endpoint: PUT /groups/:groupId/members/:userIdGitLab Endpoint: PUT /groups/:groupId/members/:userIdGitLab Endpoint: PUT /groups/:groupId/members/:userIdGitLab Endpoint: PUT /groups/:groupId/members/:userIdGitLab Endpoint: DELETE /groups/:id/members/:user_idGitLab Endpoint: GET /issuesGitLab Endpoint: GET /issuesGitLab Endpoint: GET /issuesGitLab Endpoint: GET /issuesGitLab Endpoint: GET /projects/:id/issuesGitLab Endpoint: GET /projects/:id/issuesGitLab Endpoint: GET /projects/:id/issuesGitLab Endpoint: GET /projects/:id/issuesGitLab Endpoint: GET /projects/:id/issuesGitLab Endpoint: GET /projects/:id/issuesGitLab Endpoint: GET /projects/:id/issuesGitLab Endpoint: GET /projects/:id/issuesGitLab Endpoint: GET /issuesGitLab Endpoint: GET /issuesGitLab Endpoint: GET /issuesGitLab Endpoint: GET /issuesGitLab Endpoint: GET /projects/:id/issues/:issue_iidGitLab Endpoint: GET /projects/:id/issues/:issue_iidGitLab Endpoint: POST /projects/:id/issuesGitLab Endpoint: POST /projects/:id/issuesGitLab Endpoint: PUT /projects/:id/issues/:issue_iidGitLab Endpoint: PUT /projects/:id/issues/:issue_iidGitLab Endpoint: DELETE /projects/:id/issues/:issue_iidGitLab Endpoint: POST /projects/:id/issues/:issue_iid/time_estimateGitLab Endpoint: POST /projects/:id/issues/:issue_iid/time_estimateGitLab Endpoint: POST /projects/:id/issues/:issue_iid/time_estimateGitLab Endpoint: POST /projects/:id/issues/:issue_iid/reset_time_estimateGitLab Endpoint: POST /projects/:id/issues/:issue_iid/add_spent_timeGitLab Endpoint: POST /projects/:id/issues/:issue_iid/add_spent_timeGitLab Endpoint: POST /projects/:id/issues/:issue_iid/add_spent_timeGitLab Endpoint: POST /projects/:id/issues/:issue_iid/reset_spent_timeGitLab Endpoint: GET /projects/:id/issues/:issue_iid/time_statsGitLab Endpoint: GET /projects/:id/issues/:issue_iid/time_statsGitLab Endpoint: GET /projects/:id/issues/:issue_iid/closed_byGitLab Endpoint: GET /projects/:id/issues/:issue_iid/closed_byGitLab Endpoint: GET /projects/:id/issues/:issue_iid/closed_byGitLab Endpoint: GET /projects/:id/issues/:issue_iid/closed_byGitLab Endpoint: GET /projects/:id/issues/:issue_iid/notesGitLab Endpoint: GET /projects/:id/issues/:issue_iid/notesGitLab Endpoint: GET /projects/:id/issues/:issue_iid/notesGitLab Endpoint: GET /projects/:id/issues/:issue_iid/notesGitLab Endpoint: GET /projects/:id/issues/:issue_iid/notesGitLab Endpoint: GET /projects/:id/issues/:issue_iid/notesGitLab Endpoint: GET /projects/:id/issues/:issue_iid/notesGitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/notesGitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/notesGitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/notesGitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/notesGitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/notesGitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/notesGitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/notesGitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/notesGitLab Endpoint: GET /projects/:id/repository/tagsGitLab Endpoint: GET /projects/:id/repository/tagsGitLab Endpoint: GET /projects/:id/repository/tagsGitLab Endpoint: GET /projects/:id/repository/tagsGitLab Endpoint: GET /projects/:id/repository/tags/:tagNameGitLab Endpoint: GET /projects/:id/repository/tags/:tagNameGitLab Endpoint: POST /projects/:id/repository/tagsGitLab Endpoint: POST /projects/:id/repository/tagsGitLab Endpoint: DELETE /projects/:id/repository/tags/:tag_nameGitLab Endpoint: POST /projects/:id/repository/tags/:tagName/releaseGitLab Endpoint: PUT /projects/:id/repository/tags/:tagName/release- * GET /users + * Get a list of users. * - * @return a list of Users, this list will only contain the first 100 users in the system. + *
GitLab Endpoint: GET /users- * GET /users + * + *
GitLab Endpoint: GET /users- * GET /users + * + *
GitLab Endpoint: GET /users- * GET /users?active=true + * Get a Stream of users. + * + *
GitLab Endpoint: GET /usersGitLab Endpoint: GET /users?active=true- * GET /users?active=true * - * @param page the page to get + *
GitLab Endpoint: GET /users?active=true- * GET /users?active=true + * + *
GitLab Endpoint: GET /users?active=trueGitLab Endpoint: GET /users?active=true- * POST /users/:id/block + * + *
GitLab Endpoint: POST /users/:id/block- * POST /users/:id/unblock + * + *
GitLab Endpoint: POST /users/:id/unblock- * GET /users?blocked=true + * Get a list of blocked users. * - * @return a list of blocked Users, this list will only contain the first 100 users in the system. + *
GitLab Endpoint: GET /users?blocked=true- * GET /users?blocked=true + * + *
GitLab Endpoint: GET /users?blocked=true- * GET /users?blocked=true + * + *
GitLab Endpoint: GET /users?blocked=trueGitLab Endpoint: GET /users?blocked=true- * GET /users/:id + * + *
GitLab Endpoint: GET /users/:id- * GET /users/:id + * + *
GitLab Endpoint: GET /users/:id- * NOTE: This is for admin users only. - *
- * GET /users?username=:username + * + *
NOTE: This is for admin users only.
+ * + *GitLab Endpoint: GET /users?username=:username- * NOTE: This is for admin users only. - *
- * GET /users?username=:username + * + *
NOTE: This is for admin users only.
+ * + *GitLab Endpoint: GET /users?username=:username- * GET /users?search=:email_or_username + * + *
GitLab Endpoint: GET /users?search=:email_or_username- * GET /users?search=:email_or_username + * + *
GitLab Endpoint: GET /users?search=:email_or_username- * GET /users?search=:email_or_username + * + *
GitLab Endpoint: GET /users?search=:email_or_usernameGitLab Endpoint: GET /users?search=:email_or_usernameCreates 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 + * 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
+ * GitLab Endpoint: 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
@@ -394,9 +423,9 @@ public class UserApi extends AbstractApi {
* 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
+ * GitLab Endpoint: 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
@@ -431,9 +460,9 @@ public class UserApi extends AbstractApi {
/**
* 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
+ * GitLab Endpoint: 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
@@ -467,9 +496,9 @@ public class UserApi extends AbstractApi {
/**
* 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
+ * GitLab Endpoint: 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
@@ -505,67 +534,36 @@ public class UserApi extends AbstractApi {
/**
* Deletes a user. Available only for administrators.
- *
- * DELETE /users/:id
*
- * @param userId the user ID to delete
- * @throws GitLabApiException if any exception occurs
- */
- public void deleteUser(Integer userId) throws GitLabApiException {
- deleteUser(userId, null);
- }
-
- /**
- * Deletes a user. Available only for administrators.
- *
- * DELETE /users/:id
+ *
GitLab Endpoint: DELETE /users/:id
*
- * @param userId the user ID to delete
- * @param 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
+ * @param userIdOrUsername the user in the form of an Integer(ID), String(username), or User instance
* @throws GitLabApiException if any exception occurs
*/
- public void deleteUser(Integer userId, Boolean hardDelete) throws GitLabApiException {
-
- if (userId == null) {
- throw new RuntimeException("userId cannot be null");
- }
-
- GitLabApiForm formData = new GitLabApiForm().withParam("hard_delete ", hardDelete);
- Response.Status expectedStatus = (isApiVersion(ApiVersion.V3) ? Response.Status.OK : Response.Status.NO_CONTENT);
- delete(expectedStatus, formData.asMap(), "users", userId);
+ public void deleteUser(Object userIdOrUsername) throws GitLabApiException {
+ deleteUser(userIdOrUsername, null);
}
/**
* Deletes a user. Available only for administrators.
- *
- * DELETE /users/:id
*
- * @param user the User instance to delete
- * @throws GitLabApiException if any exception occurs
- */
- public void deleteUser(User user) throws GitLabApiException {
- deleteUser(user.getId(), null);
- }
-
- /**
- * Deletes a user. Available only for administrators.
- *
- * DELETE /users/:id
+ *
GitLab Endpoint: DELETE /users/:id
*
- * @param user the User instance to delete
+ * @param userIdOrUsername the user in the form of an Integer(ID), String(username), or User instance
* @param 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
*/
- public void deleteUser(User user, Boolean hardDelete) throws GitLabApiException {
- deleteUser(user.getId(), hardDelete);
+ public void deleteUser(Object userIdOrUsername, Boolean hardDelete) throws GitLabApiException {
+ GitLabApiForm formData = new GitLabApiForm().withParam("hard_delete ", hardDelete);
+ Response.Status expectedStatus = (isApiVersion(ApiVersion.V3) ? Response.Status.OK : Response.Status.NO_CONTENT);
+ delete(expectedStatus, formData.asMap(), "users", getUserIdOrUsername(userIdOrUsername));
}
/**
* Get currently authenticated user.
- *
- * GET /user
+ *
+ *
GitLab Endpoint: GET /user
*
* @return the User instance for the currently authenticated user
* @throws GitLabApiException if any exception occurs
@@ -577,24 +575,23 @@ public class UserApi extends AbstractApi {
/**
* Get a list of currently authenticated user's SSH keys.
- *
- * GET /user/keys
+ *
+ *
GitLab Endpoint: GET /user/keys
*
* @return a list of currently authenticated user's SSH keys
* @throws GitLabApiException if any exception occurs
*/
public List getSshKeys() throws GitLabApiException {
Response response = get(Response.Status.OK, getDefaultPerPageParam(), "user", "keys");
- return (response.readEntity(new GenericType>() {
- }));
+ return (response.readEntity(new GenericType>() {}));
}
/**
* Get a list of a specified user's SSH keys. Available only for admin users.
- *
- * GET /users/:id/keys
*
- * @param userId the ID of the user to get SSH keys for
+ *
GitLab Endpoint: GET /users/:id/keys
+ *
+ * @param userId the user ID to get the SSH keys for
* @return a list of a specified user's SSH keys
* @throws GitLabApiException if any exception occurs
*/
@@ -605,14 +602,10 @@ public class UserApi extends AbstractApi {
}
Response response = get(Response.Status.OK, getDefaultPerPageParam(), "users", userId, "keys");
- List keys = response.readEntity(new GenericType>() {
- });
- if (keys == null) {
- return (keys);
- }
+ List keys = response.readEntity(new GenericType>() {});
- for (SshKey key : keys) {
- key.setUserId(userId);
+ if (keys != null) {
+ keys.forEach(key -> key.setUserId(userId));
}
return (keys);
@@ -620,8 +613,8 @@ public class UserApi extends AbstractApi {
/**
* Get a single SSH Key.
- *
- * GET /user/keys/:key_id
+ *
+ *
GitLab Endpoint: GET /user/keys/:key_id
*
* @param keyId the ID of the SSH key.
* @return an SshKey instance holding the info on the SSH key specified by keyId
@@ -634,8 +627,8 @@ public class UserApi extends AbstractApi {
/**
* Get a single SSH Key as an Optional instance.
- *
- * GET /user/keys/:key_id
+ *
+ *
GitLab Endpoint: GET /user/keys/:key_id
*
* @param keyId the ID of the SSH key
* @return an SshKey as an Optional instance holding the info on the SSH key specified by keyId
@@ -650,8 +643,8 @@ public class UserApi extends AbstractApi {
/**
* Creates a new key owned by the currently authenticated user.
- *
- * POST /user/keys
+ *
+ *
GitLab Endpoint: POST /user/keys
*
* @param title the new SSH Key's title
* @param key the new SSH key
@@ -666,8 +659,8 @@ public class UserApi extends AbstractApi {
/**
* Create new key owned by specified user. Available only for admin users.
- *
- * POST /users/:id/keys
+ *
+ *
GitLab Endpoint: POST /users/:id/keys
*
* @param userId the ID of the user to add the SSH key for
* @param title the new SSH Key's title
@@ -694,8 +687,8 @@ public class UserApi extends AbstractApi {
/**
* 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
+ *
+ *
GitLab Endpoint: DELETE /user/keys/:key_id
*
* @param keyId the key ID to delete
* @throws GitLabApiException if any exception occurs
@@ -712,100 +705,86 @@ public class UserApi extends AbstractApi {
/**
* Deletes key owned by a specified user. Available only for admin users.
- *
- * DELETE /users/:id/keys/:key_id
*
- * @param userId the user ID of the user to delete the key for
+ *
GitLab Endpoint: DELETE /users/:id/keys/:key_id
+ *
+ * @param userIdOrUsername the user in the form of an Integer(ID), String(username), or User instance
* @param keyId the key ID to delete
* @throws GitLabApiException if any exception occurs
*/
- public void deleteSshKey(Integer userId, Integer keyId) throws GitLabApiException {
-
- if (userId == null) {
- throw new RuntimeException("userId cannot be null");
- }
+ public void deleteSshKey(Object userIdOrUsername, Integer keyId) throws GitLabApiException {
if (keyId == null) {
throw new RuntimeException("keyId cannot be null");
}
Response.Status expectedStatus = (isApiVersion(ApiVersion.V3) ? Response.Status.OK : Response.Status.NO_CONTENT);
- delete(expectedStatus, null, "users", userId, "keys", keyId);
+ delete(expectedStatus, null, "users", getUserIdOrUsername(userIdOrUsername), "keys", keyId);
}
/**
* Get a list of a specified user's impersonation tokens. Available only for admin users.
- *
- * GET /users/:id/impersonation_tokens
*
- * @param userId the ID of the user to get impersonation tokens for
+ *
GitLab Endpoint: GET /users/:id/impersonation_tokens
+ *
+ * @param userIdOrUsername the user in the form of an Integer(ID), String(username), or User instance
* @return a list of a specified user's impersonation tokens
* @throws GitLabApiException if any exception occurs
*/
- public List getImpersonationTokens(Integer userId) throws GitLabApiException {
- return (getImpersonationTokens(userId, null));
+ public List getImpersonationTokens(Object userIdOrUsername) throws GitLabApiException {
+ return (getImpersonationTokens(userIdOrUsername, null));
}
/**
* Get a list of a specified user's impersonation tokens. Available only for admin users.
- *
- * GET /users/:id/impersonation_tokens
*
- * @param userId the ID of the user to get impersonation tokens for
+ *
GitLab Endpoint: GET /users/:id/impersonation_tokens
+ *
+ * @param userIdOrUsername the user in the form of an Integer(ID), String(username), or User instance
* @param state the state of impersonation tokens to list (ALL, ACTIVE, INACTIVE)
* @return a list of a specified user's impersonation tokens
* @throws GitLabApiException if any exception occurs
*/
- public List getImpersonationTokens(Integer userId, ImpersonationState state) throws GitLabApiException {
-
- if (userId == null) {
- throw new RuntimeException("userId cannot be null");
- }
-
+ public List getImpersonationTokens(Object userIdOrUsername, ImpersonationState state) throws GitLabApiException {
GitLabApiForm formData = new GitLabApiForm()
.withParam("state", state)
.withParam(PER_PAGE_PARAM, getDefaultPerPage());
- Response response = get(Response.Status.OK, formData.asMap(), "users", userId, "impersonation_tokens");
- return (response.readEntity(new GenericType>() {
- }));
+ Response response = get(Response.Status.OK, formData.asMap(), "users", getUserIdOrUsername(userIdOrUsername), "impersonation_tokens");
+ return (response.readEntity(new GenericType>() {}));
}
/**
* Get an impersonation token of a user. Available only for admin users.
- *
- * GET /users/:user_id/impersonation_tokens/:impersonation_token_id
*
- * @param userId the ID of the user to get SSH keys for
+ *
GitLab Endpoint: GET /users/:user_id/impersonation_tokens/:impersonation_token_id
+ *
+ * @param userIdOrUsername the user in the form of an Integer(ID), String(username), or User instance
* @param tokenId the impersonation token ID to get
* @return the specified impersonation token
* @throws GitLabApiException if any exception occurs
*/
- public ImpersonationToken getImpersonationToken(Integer userId, Integer tokenId) throws GitLabApiException {
-
- if (userId == null) {
- throw new RuntimeException("userId cannot be null");
- }
+ public ImpersonationToken getImpersonationToken(Object userIdOrUsername, Integer tokenId) throws GitLabApiException {
if (tokenId == null) {
throw new RuntimeException("tokenId cannot be null");
}
- Response response = get(Response.Status.OK, null, "users", userId, "impersonation_tokens", tokenId);
+ Response response = get(Response.Status.OK, null, "users", getUserIdOrUsername(userIdOrUsername), "impersonation_tokens", tokenId);
return (response.readEntity(ImpersonationToken.class));
}
/**
* 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
*
- * @param userId the ID of the user to get SSH keys for
+ *
GitLab Endpoint: GET /users/:user_id/impersonation_tokens/:impersonation_token_id
+ *
+ * @param userIdOrUsername the user in the form of an Integer(ID), String(username), or User instance
* @param tokenId the impersonation token ID to get
* @return the specified impersonation token as an Optional instance
*/
- public Optional getOptionalImpersonationToken(Integer userId, Integer tokenId) {
+ public Optional getOptionalImpersonationToken(Object userIdOrUsername, Integer tokenId) {
try {
- return (Optional.ofNullable(getImpersonationToken(userId, tokenId)));
+ return (Optional.ofNullable(getImpersonationToken(userIdOrUsername, tokenId)));
} catch (GitLabApiException glae) {
return (GitLabApi.createOptionalFromException(glae));
}
@@ -813,21 +792,17 @@ public class UserApi extends AbstractApi {
/**
* Create an impersonation token. Available only for admin users.
- *
- * POST /users/:user_id/impersonation_tokens
*
- * @param userId the ID of the user to get SSH keys for
- * @param name the name of the impersonation token, required
+ *
GitLab Endpoint: POST /users/:user_id/impersonation_tokens
+ *
+ * @param userIdOrUsername the user in the form of an Integer(ID), String(username), or User instance
+ * @param name the name of the impersonation token, required
* @param expiresAt the expiration date of the impersonation token, optional
- * @param scopes an array of scopes of the impersonation token
+ * @param scopes an array of scopes of the impersonation token
* @return the created ImpersonationToken instance
* @throws GitLabApiException if any exception occurs
*/
- public ImpersonationToken createImpersonationToken(Integer userId, String name, Date expiresAt, Scope[] scopes) throws GitLabApiException {
-
- if (userId == null) {
- throw new RuntimeException("userId cannot be null");
- }
+ public ImpersonationToken createImpersonationToken(Object userIdOrUsername, String name, Date expiresAt, Scope[] scopes) throws GitLabApiException {
if (scopes == null || scopes.length == 0) {
throw new RuntimeException("scopes cannot be null or empty");
@@ -841,31 +816,27 @@ public class UserApi extends AbstractApi {
formData.withParam("scopes[]", scope.toString());
}
- Response response = post(Response.Status.CREATED, formData, "users", userId, "impersonation_tokens");
+ Response response = post(Response.Status.CREATED, formData, "users", getUserIdOrUsername(userIdOrUsername), "impersonation_tokens");
return (response.readEntity(ImpersonationToken.class));
}
/**
* Revokes an impersonation token. Available only for admin users.
- *
- * DELETE /users/:user_id/impersonation_tokens/:impersonation_token_id
*
- * @param userId the user ID of the user to revoke the impersonation token for
+ *
GitLab Endpoint: DELETE /users/:user_id/impersonation_tokens/:impersonation_token_id
+ *
+ * @param userIdOrUsername the user in the form of an Integer(ID), String(username), or User instance
* @param tokenId the impersonation token ID to revoke
* @throws GitLabApiException if any exception occurs
*/
- public void revokeImpersonationToken(Integer userId, Integer tokenId) throws GitLabApiException {
-
- if (userId == null) {
- throw new RuntimeException("userId cannot be null");
- }
+ public void revokeImpersonationToken(Object userIdOrUsername, Integer tokenId) throws GitLabApiException {
if (tokenId == null) {
throw new RuntimeException("tokenId cannot be null");
}
Response.Status expectedStatus = (isApiVersion(ApiVersion.V3) ? Response.Status.OK : Response.Status.NO_CONTENT);
- delete(expectedStatus, null, "users", userId, "impersonation_tokens", tokenId);
+ delete(expectedStatus, null, "users", getUserIdOrUsername(userIdOrUsername), "impersonation_tokens", tokenId);
}
/**
@@ -878,11 +849,13 @@ public class UserApi extends AbstractApi {
* @return the populated Form instance
*/
Form userToForm(User user, Integer projectsLimit, CharSequence password, Boolean resetPassword, boolean create) {
+
if (create) {
if ((password == null || password.toString().trim().isEmpty()) && !resetPassword) {
throw new IllegalArgumentException("either password or reset_password must be set");
}
}
+
projectsLimit = (projectsLimit == null) ? user.getProjectsLimit() : projectsLimit;
String skipConfirmationFeildName = create ? "skip_confirmation" : "skip_reconfirmation";
@@ -912,31 +885,29 @@ public class UserApi extends AbstractApi {
/**
* Creates custom attribute for the given user
*
- * @param userId to set the customAttributes for
- * @param customAttribute to set
- * @return createdCustomAttribute
+ * @param userIdOrUsername the user in the form of an Integer(ID), String(username), or User instance
+ * @param customAttribute the custom attribute to set
+ * @return the created CustomAttribute
* @throws GitLabApiException on failure while setting customAttributes
*/
- public CustomAttribute createCustomAttribute(final Integer userId, final CustomAttribute customAttribute) throws GitLabApiException {
+ public CustomAttribute createCustomAttribute(final Object userIdOrUsername, final CustomAttribute customAttribute) throws GitLabApiException {
if (Objects.isNull(customAttribute)) {
throw new IllegalArgumentException("CustomAttributes can't be null");
}
- return createCustomAttribute(userId, customAttribute.getKey(), customAttribute.getValue());
+ return createCustomAttribute(userIdOrUsername, customAttribute.getKey(), customAttribute.getValue());
}
/**
* Creates custom attribute for the given user
*
- * @param userId to set the customAttributes for
- * @param key for the customAttribute
- * @param value for the customAttribute
- * @return createdCustomAttribute
+ * @param userIdOrUsername the user in the form of an Integer(ID), String(username), or User instance
+ * @param key for the customAttribute
+ * @param value or the customAttribute
+ * @return the created CustomAttribute
* @throws GitLabApiException on failure while setting customAttributes
*/
- public CustomAttribute createCustomAttribute(final Integer userId, final String key, final String value) throws GitLabApiException {
- if (Objects.isNull(userId)) {
- throw new IllegalArgumentException("UserId can't be null.");
- }
+ public CustomAttribute createCustomAttribute(final Object userIdOrUsername, final String key, final String value) throws GitLabApiException {
+
if (Objects.isNull(key) || key.trim().isEmpty()) {
throw new IllegalArgumentException("Key can't be null or empty");
}
@@ -944,73 +915,73 @@ public class UserApi extends AbstractApi {
throw new IllegalArgumentException("Value can't be null or empty");
}
- GitLabApiForm formData = new GitLabApiForm()
- .withParam("value", value);
- Response response = put(Response.Status.OK, formData.asMap(), "users", userId, "custom_attributes", key);
+ GitLabApiForm formData = new GitLabApiForm().withParam("value", value);
+ Response response = put(Response.Status.OK, formData.asMap(),
+ "users", getUserIdOrUsername(userIdOrUsername), "custom_attributes", key);
return (response.readEntity(CustomAttribute.class));
}
/**
* Change custom attribute for the given user
*
- * @param userId to change the customAttributes for
- * @param customAttribute to change
- * @return changedCustomAttribute
+ * @param userIdOrUsername the user in the form of an Integer(ID), String(username), or User instance
+ * @param customAttribute the custome attribute to change
+ * @return the changed CustomAttribute
* @throws GitLabApiException on failure while changing customAttributes
*/
- public CustomAttribute changeCustomAttribute(final Integer userId, final CustomAttribute customAttribute) throws GitLabApiException {
+ public CustomAttribute changeCustomAttribute(final Object userIdOrUsername, final CustomAttribute customAttribute) throws GitLabApiException {
+
if (Objects.isNull(customAttribute)) {
throw new IllegalArgumentException("CustomAttributes can't be null");
}
//changing & creating custom attributes is the same call in gitlab api
// -> https://docs.gitlab.com/ce/api/custom_attributes.html#set-custom-attribute
- return createCustomAttribute(userId, customAttribute.getKey(), customAttribute.getValue());
+ return createCustomAttribute(userIdOrUsername, customAttribute.getKey(), customAttribute.getValue());
}
/**
* Changes custom attribute for the given user
*
- * @param userId to change the customAttribute for
+ * @param userIdOrUsername the user in the form of an Integer(ID), String(username), or User instance
* @param key for the customAttribute
* @param value for the customAttribute
* @return changedCustomAttribute
* @throws GitLabApiException on failure while changing customAttributes
*/
- public CustomAttribute changeCustomAttribute(final Integer userId, final String key, final String value) throws GitLabApiException {
- return createCustomAttribute(userId, key, value);
+ public CustomAttribute changeCustomAttribute(final Object userIdOrUsername, final String key, final String value) throws GitLabApiException {
+ return createCustomAttribute(userIdOrUsername, key, value);
}
/**
* Delete a custom attribute for the given user
*
- * @param userId to delete the customAttribute for
+ * @param userIdOrUsername the user in the form of an Integer(ID), String(username), or User instance
* @param customAttribute to remove
* @throws GitLabApiException on failure while deleting customAttributes
*/
- public void deleteCustomAttribute(final Integer userId, final CustomAttribute customAttribute) throws GitLabApiException {
+ public void deleteCustomAttribute(final Object userIdOrUsername, final CustomAttribute customAttribute) throws GitLabApiException {
if (Objects.isNull(customAttribute)) {
throw new IllegalArgumentException("customAttributes can't be null");
}
- deleteCustomAttribute(userId, customAttribute.getKey());
+ deleteCustomAttribute(userIdOrUsername, customAttribute.getKey());
}
/**
* Delete a custom attribute for the given user
*
- * @param userId to delete the customAttribute for
+ * @param userIdOrUsername the user in the form of an Integer(ID), String(username), or User instance
* @param key of the customAttribute to remove
* @throws GitLabApiException on failure while deleting customAttributes
*/
- public void deleteCustomAttribute(final Integer userId, final String key) throws GitLabApiException {
- if (Objects.isNull(userId)) {
- throw new IllegalArgumentException("UserId can't be null");
- }
+ public void deleteCustomAttribute(final Object userIdOrUsername, final String key) throws GitLabApiException {
+
if (Objects.isNull(key) || key.trim().isEmpty()) {
throw new IllegalArgumentException("Key can't be null or empty");
}
- delete(Response.Status.OK, null, "users", userId, "custom_attributes", key);
+
+ delete(Response.Status.OK, null, "users", getUserIdOrUsername(userIdOrUsername), "custom_attributes", key);
}
/**