|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.rest.v2.issue.UserResource
public class UserResource
Constructor Summary | |
---|---|
UserResource(UserUtil userUtil,
I18nHelper i18n,
EmailFormatter emailFormatter,
JiraAuthenticationContext authContext,
TimeZoneManager timeZoneManager,
AvatarPickerHelper avatarPickerHelper,
AvatarManager avatarManager,
AvatarService avatarService,
AttachmentHelper attachmentHelper,
UserPropertyManager userPropertyManager,
PermissionManager permissionManager,
ProjectService projectService,
IssueService issueService,
ProjectManager projectManager,
com.atlassian.event.api.EventPublisher eventPublisher,
AssigneeService assigneeService,
IssueManager issueManager,
UserPickerResourceHelper userPickerHelper,
JiraBaseUrls jiraBaseUrls)
|
Method Summary | |
---|---|
javax.ws.rs.core.Response |
createAvatarFromTemporary(String username,
AvatarCroppingBean croppingInstructions)
Converts temporary avatar into a real avatar |
javax.ws.rs.core.Response |
deleteAvatar(String username,
Long id)
Deletes avatar |
javax.ws.rs.core.Response |
findAssignableUsers(String name,
String projectKey,
String issueKey,
Integer startAt,
Integer maxResults,
Integer actionDescriptorId,
javax.ws.rs.core.UriInfo uriInfo)
Returns a list of users that match the search string. |
javax.ws.rs.core.Response |
findBulkAssignableUsers(String name,
String projectKeysStr,
Integer startAt,
Integer maxResults,
javax.ws.rs.core.UriInfo uriInfo)
Returns a list of users that match the search string and can be assigned issues for all the given projects. |
javax.ws.rs.core.Response |
findUsers(String username,
Integer startAt,
Integer maxResults,
Boolean includeActive,
Boolean includeInactive,
javax.ws.rs.core.UriInfo uriInfo)
Returns a list of users that match the search string. |
javax.ws.rs.core.Response |
findUsersForPicker(String query,
Integer maxResults,
Boolean showAvatar,
List<String> excludeUsers)
Returns a list of users matching query with highlighting. |
javax.ws.rs.core.Response |
findUsersWithBrowsePermission(String name,
String issueKey,
String projectKey,
Integer startAt,
Integer maxResults,
javax.ws.rs.core.UriInfo uriInfo)
Returns a list of active users that match the search string. |
protected com.opensymphony.workflow.loader.ActionDescriptor |
getActionDescriptorById(String issueKey,
Integer actionDescriptorId)
|
javax.ws.rs.core.Response |
getAllAvatars(String name)
Returns all avatars which are visible for the currently logged in user. |
javax.ws.rs.core.Response |
getUser(String name,
String key,
javax.ws.rs.core.UriInfo uriInfo)
Returns a user. |
javax.ws.rs.core.Response |
storeTemporaryAvatar(String username,
String filename,
Long size,
javax.servlet.http.HttpServletRequest request)
Creates temporary avatar. |
javax.ws.rs.core.Response |
storeTemporaryAvatarUsingMultiPart(String username,
com.atlassian.plugins.rest.common.multipart.FilePart filePart,
javax.servlet.http.HttpServletRequest request)
Creates temporary avatar using multipart. |
javax.ws.rs.core.Response |
updateProjectAvatar(String username,
AvatarBean avatarBean)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public UserResource(UserUtil userUtil, I18nHelper i18n, EmailFormatter emailFormatter, JiraAuthenticationContext authContext, TimeZoneManager timeZoneManager, AvatarPickerHelper avatarPickerHelper, AvatarManager avatarManager, AvatarService avatarService, AttachmentHelper attachmentHelper, UserPropertyManager userPropertyManager, PermissionManager permissionManager, ProjectService projectService, IssueService issueService, ProjectManager projectManager, com.atlassian.event.api.EventPublisher eventPublisher, AssigneeService assigneeService, IssueManager issueManager, UserPickerResourceHelper userPickerHelper, JiraBaseUrls jiraBaseUrls)
Method Detail |
---|
public javax.ws.rs.core.Response getUser(String name, String key, @Context javax.ws.rs.core.UriInfo uriInfo)
name
- the usernamepublic javax.ws.rs.core.Response findUsers(String username, Integer startAt, Integer maxResults, Boolean includeActive, Boolean includeInactive, @Context javax.ws.rs.core.UriInfo uriInfo)
username
- A query string used to search username, name or e-mail addressstartAt
- the index of the first user to return (0-based)maxResults
- the maximum number of users to return (defaults to 50). The maximum allowed value is 1000.
If you specify a value that is higher than this number, your search results will be truncated.includeActive
- If true, then active users are included in the results (default true)includeInactive
- If true, then inactive users are included in the results (default false)uriInfo
- context used for creating urls in user objects
public javax.ws.rs.core.Response findUsersForPicker(String query, Integer maxResults, Boolean showAvatar, List<String> excludeUsers)
query
- A string used to search username, Name or e-mail addressmaxResults
- the maximum number of users to return (defaults to 50). The maximum allowed value is 1000.
If you specify a value that is higher than this number, your search results will be truncated.
public javax.ws.rs.core.Response findAssignableUsers(String name, String projectKey, String issueKey, Integer startAt, Integer maxResults, Integer actionDescriptorId, @Context javax.ws.rs.core.UriInfo uriInfo)
name
- the usernameprojectKey
- the key of the project we are finding assignable users forissueKey
- the issue key for the issue being edited we need to find assignable users for.startAt
- the index of the first user to return (0-based)maxResults
- the maximum number of users to return (defaults to 50). The maximum allowed value is 1000.
If you specify a value that is higher than this number, your search results will be truncated.uriInfo
- Context used for constructing user objects
protected com.opensymphony.workflow.loader.ActionDescriptor getActionDescriptorById(String issueKey, Integer actionDescriptorId)
public javax.ws.rs.core.Response findUsersWithBrowsePermission(String name, String issueKey, String projectKey, Integer startAt, Integer maxResults, @Context javax.ws.rs.core.UriInfo uriInfo)
name
- the usernameissueKey
- the issue key for the issue being edited we need to find viewable users for.projectKey
- the optional project key to search for users with if no issueKey is supplied.startAt
- the index of the first user to return (0-based)maxResults
- the maximum number of users to return (defaults to 50). The maximum allowed value is 1000.
If you specify a value that is higher than this number, your search results will be truncated.uriInfo
- Context used for constructing user objects
public javax.ws.rs.core.Response findBulkAssignableUsers(String name, String projectKeysStr, Integer startAt, Integer maxResults, @Context javax.ws.rs.core.UriInfo uriInfo)
name
- the usernamestartAt
- the index of the first user to return (0-based)maxResults
- the maximum number of users to return (defaults to 50). The maximum allowed value is 1000.
If you specify a value that is higher than this number, your search results will be truncated.projectKeysStr
- the keys of the projects we are finding assignable users for, comma-separateduriInfo
- Context used for constructing user objectspublic javax.ws.rs.core.Response getAllAvatars(String name)
name
- username
public javax.ws.rs.core.Response createAvatarFromTemporary(String username, AvatarCroppingBean croppingInstructions)
username
- usernamecroppingInstructions
- cropping instructions
public javax.ws.rs.core.Response updateProjectAvatar(String username, AvatarBean avatarBean)
public javax.ws.rs.core.Response storeTemporaryAvatar(String username, String filename, Long size, @Context javax.servlet.http.HttpServletRequest request)
The following examples shows these three steps using curl. The cookies (session) need to be preserved between requests, hence the use of -b and -c. The id created in step 2 needs to be passed to step 3 (you can simply pass the whole response of step 2 as the request of step 3).
curl -c cookiejar.txt -X POST -u admin:admin -H "X-Atlassian-Token: no-check" \ -H "Content-Type: image/png" --data-binary @mynewavatar.png \ 'http://localhost:8090/jira/rest/api/2/user/avatar/temporary?username=admin&filename=mynewavatar.png' curl -b cookiejar.txt -X POST -u admin:admin -H "X-Atlassian-Token: no-check" \ -H "Content-Type: application/json" --data '{"cropperWidth": "65","cropperOffsetX": "10","cropperOffsetY": "16"}' \ -o tmpid.json \ http://localhost:8090/jira/rest/api/2/user/avatar?username=admin curl -b cookiejar.txt -X PUT -u admin:admin -H "X-Atlassian-Token: no-check" \ -H "Content-Type: application/json" --data-binary @tmpid.json \ http://localhost:8090/jira/rest/api/2/user/avatar?username=admin
username
- usernamefilename
- name of file being uploadedsize
- size of filerequest
- servlet request
public javax.ws.rs.core.Response storeTemporaryAvatarUsingMultiPart(String username, com.atlassian.plugins.rest.common.multipart.FilePart filePart, @Context javax.servlet.http.HttpServletRequest request)
Creating a temporary avatar is part of a 3-step process in uploading a new avatar for a user: upload, crop, confirm. This endpoint allows you to use a multipart upload instead of sending the image directly as the request body.
You *must* use "avatar" as the name of the upload parameter:
curl -c cookiejar.txt -X POST -u admin:admin -H "X-Atlassian-Token: no-check" \ -F "avatar=@mynewavatar.png;type=image/png" \ 'http://localhost:8090/jira/rest/api/2/user/avatar/temporary?username=admin'
username
- Usernamerequest
- servlet request
public javax.ws.rs.core.Response deleteAvatar(String username, Long id)
username
- usernameid
- database id for avatar
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |