All URIs are relative to https://your-domain.atlassian.com
| Method | HTTP request | Description |
|---|---|---|
| deleteLocale | DELETE /rest/api/3/mypreferences/locale | Delete locale |
| getCurrentUser | GET /rest/api/3/myself | Get current user |
| getLocale | GET /rest/api/3/mypreferences/locale | Get locale |
| getPreference | GET /rest/api/3/mypreferences | Get preference |
| removePreference | DELETE /rest/api/3/mypreferences | Delete preference |
| setLocale | PUT /rest/api/3/mypreferences/locale | Set locale |
| setPreference | PUT /rest/api/3/mypreferences | Set preference |
Object deleteLocale()
Delete locale
Deprecated, use Update a user profile from the user management REST API instead. Deletes the locale of the user, which restores the default setting. Permissions required: Permission to access Jira.
// Import classes:
//import com.xminds.jira.rest.client.ApiClient;
//import com.xminds.jira.rest.client.ApiException;
//import com.xminds.jira.rest.client.Configuration;
//import com.xminds.jira.rest.client.auth.*;
//import com.xminds.jira.rest.client.api.MyselfApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
MyselfApi apiInstance = new MyselfApi();
try {
Object result = apiInstance.deleteLocale();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling MyselfApi#deleteLocale");
e.printStackTrace();
}This endpoint does not need any parameter.
Object
- Content-Type: Not defined
- Accept: application/json
User getCurrentUser(expand)
Get current user
Returns details for the current user. Permissions required: Permission to access Jira.
// Import classes:
//import com.xminds.jira.rest.client.ApiClient;
//import com.xminds.jira.rest.client.ApiException;
//import com.xminds.jira.rest.client.Configuration;
//import com.xminds.jira.rest.client.auth.*;
//import com.xminds.jira.rest.client.api.MyselfApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
MyselfApi apiInstance = new MyselfApi();
String expand = "expand_example"; // String | Use [expand](#expansion) to include additional information about user in the response. This parameter accepts a comma-separated list. Expand options include: * `groups` Returns all groups, including nested groups, the user belongs to. * `applicationRoles` Returns the application roles the user is assigned to.
try {
User result = apiInstance.getCurrentUser(expand);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling MyselfApi#getCurrentUser");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| expand | String | Use expand to include additional information about user in the response. This parameter accepts a comma-separated list. Expand options include: * `groups` Returns all groups, including nested groups, the user belongs to. * `applicationRoles` Returns the application roles the user is assigned to. | [optional] |
- Content-Type: Not defined
- Accept: application/json
Locale getLocale()
Get locale
Returns the locale for the user. If the user has no language preference set (which is the default setting) or this resource is accessed anonymous, the browser locale detected by Jira is returned. Jira detects the browser locale using the Accept-Language header in the request. However, if this doesn't match a locale available Jira, the site default locale is returned. This operation can be accessed anonymously. Permissions required: None.
// Import classes:
//import com.xminds.jira.rest.client.ApiClient;
//import com.xminds.jira.rest.client.ApiException;
//import com.xminds.jira.rest.client.Configuration;
//import com.xminds.jira.rest.client.auth.*;
//import com.xminds.jira.rest.client.api.MyselfApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
MyselfApi apiInstance = new MyselfApi();
try {
Locale result = apiInstance.getLocale();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling MyselfApi#getLocale");
e.printStackTrace();
}This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
String getPreference(key)
Get preference
Returns the value of a preference of the current user. Note that these keys are deprecated: * jira.user.locale The locale of the user. By default this is not set and the user takes the locale of the instance. * jira.user.timezone The time zone of the user. By default this is not set and the user takes the timezone of the instance. Use Update a user profile from the user management REST API to manage timezone and locale instead. Permissions required: Permission to access Jira.
// Import classes:
//import com.xminds.jira.rest.client.ApiClient;
//import com.xminds.jira.rest.client.ApiException;
//import com.xminds.jira.rest.client.Configuration;
//import com.xminds.jira.rest.client.auth.*;
//import com.xminds.jira.rest.client.api.MyselfApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
MyselfApi apiInstance = new MyselfApi();
String key = "key_example"; // String | The key of the preference.
try {
String result = apiInstance.getPreference(key);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling MyselfApi#getPreference");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| key | String | The key of the preference. |
String
- Content-Type: Not defined
- Accept: application/json
removePreference(key)
Delete preference
Deletes a preference of the user, which restores the default value of system defined settings. Note that these keys are deprecated: * jira.user.locale The locale of the user. By default, not set. The user takes the instance locale. * jira.user.timezone The time zone of the user. By default, not set. The user takes the instance timezone. Use Update a user profile from the user management REST API to manage timezone and locale instead. Permissions required: Permission to access Jira.
// Import classes:
//import com.xminds.jira.rest.client.ApiClient;
//import com.xminds.jira.rest.client.ApiException;
//import com.xminds.jira.rest.client.Configuration;
//import com.xminds.jira.rest.client.auth.*;
//import com.xminds.jira.rest.client.api.MyselfApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
MyselfApi apiInstance = new MyselfApi();
String key = "key_example"; // String | The key of the preference.
try {
apiInstance.removePreference(key);
} catch (ApiException e) {
System.err.println("Exception when calling MyselfApi#removePreference");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| key | String | The key of the preference. |
null (empty response body)
- Content-Type: Not defined
- Accept: Not defined
Object setLocale(body)
Set locale
Deprecated, use Update a user profile from the user management REST API instead. Sets the locale of the user. The locale must be one supported by the instance of Jira. Permissions required: Permission to access Jira.
// Import classes:
//import com.xminds.jira.rest.client.ApiClient;
//import com.xminds.jira.rest.client.ApiException;
//import com.xminds.jira.rest.client.Configuration;
//import com.xminds.jira.rest.client.auth.*;
//import com.xminds.jira.rest.client.api.MyselfApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
MyselfApi apiInstance = new MyselfApi();
Locale body = new Locale(); // Locale | The locale defined in a LocaleBean.
try {
Object result = apiInstance.setLocale(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling MyselfApi#setLocale");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| body | Locale | The locale defined in a LocaleBean. |
Object
- Content-Type: application/json
- Accept: application/json
Object setPreference(body, key)
Set preference
Creates a preference for the user or updates a preference's value by sending a plain text string. For example, `false`. An arbitrary preference can be created with the value containing up to 255 characters. In addition, the following keys define system preferences that can be set or created: * user.notifications.mimetype The mime type used in notifications sent to the user. Defaults to `html`. * user.notify.own.changes Whether the user gets notified of their own changes. Defaults to `false`. * user.default.share.private Whether new filters are set to private. Defaults to `true`. * user.keyboard.shortcuts.disabled Whether keyboard shortcuts are disabled. Defaults to `false`. * user.autowatch.disabled Whether the user automatically watches issues they create or add a comment to. By default, not set: the user takes the instance autowatch setting. Note that these keys are deprecated: * jira.user.locale The locale of the user. By default, not set. The user takes the instance locale. * jira.user.timezone The time zone of the user. By default, not set. The user takes the instance timezone. Use Update a user profile from the user management REST API to manage timezone and locale instead. Permissions required: Permission to access Jira.
// Import classes:
//import com.xminds.jira.rest.client.ApiClient;
//import com.xminds.jira.rest.client.ApiException;
//import com.xminds.jira.rest.client.Configuration;
//import com.xminds.jira.rest.client.auth.*;
//import com.xminds.jira.rest.client.api.MyselfApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
MyselfApi apiInstance = new MyselfApi();
String body = "body_example"; // String | The value of the preference as a plain text string. The maximum length is 255 characters.
String key = "key_example"; // String | The key of the preference. The maximum length is 255 characters.
try {
Object result = apiInstance.setPreference(body, key);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling MyselfApi#setPreference");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| body | String | The value of the preference as a plain text string. The maximum length is 255 characters. | |
| key | String | The key of the preference. The maximum length is 255 characters. |
Object
- Content-Type: application/json, text/plain
- Accept: application/json