Users API

security

api

Users

Get Users

REST End-point	`GET` /api/users.ashx/users
Client API Method	UsersService.GetUsers
Request Body

Returns an array of UserEN objects.

Get User

REST End-point	`GET` /api/users.ashx/users/{userId}
Client API Method	UsersService.GetUser
Request Body

Returns UserEN based upon provided Users Id.

Get User By Username

REST End-point	`GET` /api/users.ashx/users/username/{username}
Client API Method	UsersService.GetUserByName
Request Body

Returns UserEN based upon provided Username.

Create User

REST End-point	`POST` /api/users.ashx/users/{userId}
Client API Method	UsersService.CreateUser
Request Body	UserEN

Creates new User based upon provided UserEN object.

Returns a UserEN object that will contain new Userd Id.

Update User

REST End-point	`PUT` /api/users.ashx/users/{userId}
Client API Method	UsersService.UpdateUser
Request Body	UserEN

Updates an existing UserEN object.

Returns the updated UserEN object.

Update User Profile

REST End-point	`PUT` /api/users.ashx/users/{userId}/profile
Client API Method	UsersService.UpdateUserProfile
Request Body	UserEN

Updates an existing UserEN object -- just the profile fields.

Returns the updated UserEN object.

Delete User

REST End-point	`DELETE` /api/users.ashx/users/{userId}
Client API Method	UsersService.DeleteUser
Request Body

Deletes an existing UserEN object.

User Settings

Get User Settings

REST End-point	`GET` /api/users.ashx/users/{userId}/settings
Client API Method	UsersService.GetUserSettings
Request Body

Returns an array of UserSettingsEN objects that represent specified user's settings.

Update User Settings

REST End-point	`PUT` /api/users.ashx/users/{userId}/settings
Client API Method	UsersService.UpdateUserSettings
Request Body	UserSettingsEN

Updates an existing UserSettingsEN object for the specified user.

Returns the updated UserSettingsEN object.

Saved Issue Filters

Get User Filters

REST End-point	`GET` /api/users.ashx/users/{userId}/filters
Client API Method	UsersService.GetUserSavedFilters
Request Body

Returns an array of IssuesFilterEN objects that represent the specified users saved Issue Filters (across all Projects).

Get User Filters For Project

REST End-point	`GET` /api/users.ashx/users/{userId}/projects/{projectId}/filters
Client API Method	UsersService.GetUserSavedFilters
Request Body

Returns an array of IssuesFilterEN objects that represent the specified users saved Issue Filters for the specified Project.

Create Issue filter

REST End-point	`POST` /api/users.ashx/users/{userId}/filters
Client API Method	UsersService.CreateIssueFilter
Request Body	IssuesFilterEN

Creates new Issues Filter for the specified User based upon provided IssuesFilterEN object.

Returns a IssuesFilterEN object that will contain new Issue Filter Id.

User Accessible Projects

Get User Projects

REST End-point	`GET` /api/users.ashx/users/{userId}/projects
Client API Method	UsersService.GetAccessibleProjects
Request Body

Returns an array of ProjectEN objects that represent the Projects that the specified user can see.

NOTE: The UserEN object already contains the user's accessible projects. Hence this method should be avoided.

Previous | Next


10.12	API	api
10.12.1	Introduction	api
10.12.2	Enabling API support	install api
10.12.3	Authentication	api
10.12.4	Response Formats	api
10.12.5	.NET Quick-start	api
10.12.6	Schema Reference	api
10.12.7	Administration API	admin api
10.12.8	Alerts API	api emails
10.12.9	Custom Fields API	custom-fields items api
10.12.10	Groups API	api
10.12.11	Items API	items api
10.12.12	Projects API	projects api
10.12.13	Users API	api
10.12.14	Testing API	testing api

Gemini Community Support Site