org.everit.atlassian.restclient.jiracloud.v3.api

Class UserPropertyApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v3.api.UserPropertyApi

public class UserPropertyApi
extends Object

Constructor Summary

Constructors

Constructor and Description
UserPropertyApi(org.everit.http.restclient.RestClient restClient)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Completable	deleteUserProperty(String propertyKey, Optional<String> accountId, Optional<String> userKey, Optional<String> username, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete user property Deletes a property from a user.
io.reactivex.Single<EntityProperty>	getUserProperty(String propertyKey, Optional<String> accountId, Optional<String> userKey, Optional<String> username, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get user property Returns the value of a user's property.
io.reactivex.Single<PropertyKeys>	getUserPropertyKeys(Optional<String> accountId, Optional<String> userKey, Optional<String> username, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get user property keys Returns the keys of all properties for a user.
io.reactivex.Single<Object>	setUserProperty(String propertyKey, Object body, Optional<String> accountId, Optional<String> userKey, Optional<String> username, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set user property Sets the value of a user's property.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserPropertyApi

public UserPropertyApi(org.everit.http.restclient.RestClient restClient)

Method Detail

deleteUserProperty

public io.reactivex.Completable deleteUserProperty(String propertyKey,
                                                   Optional<String> accountId,
                                                   Optional<String> userKey,
                                                   Optional<String> username,
                                                   Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete user property

Deletes a property from a user.

Permissions required:

• Administer Jira global permission, to delete a property from any user.
• Access to Jira, to delete a property from the calling user's record.

Note: These user properties are unrelated to the user properties that are set in Jira.

Parameters:

propertyKey -

The key of the user's property.

(required)

accountId -

The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required.

(optional)

userKey -

This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

(optional)

username -

This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

(optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Completable

getUserProperty

public io.reactivex.Single<EntityProperty> getUserProperty(String propertyKey,
                                                           Optional<String> accountId,
                                                           Optional<String> userKey,
                                                           Optional<String> username,
                                                           Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get user property

Returns the value of a user's property. If no property key is provided Get user property keys is called.

Permissions required:

• Administer Jira global permission, to get a property from any user.
• Access to Jira, to get a property from the calling user's record.

Note: These user properties are unrelated to the user properties that are set in Jira.

Parameters:

propertyKey -

The key of the user's property.

(required)

accountId -

The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required.

(optional)

userKey -

This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

(optional)

username -

This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

(optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<EntityProperty>

getUserPropertyKeys

public io.reactivex.Single<PropertyKeys> getUserPropertyKeys(Optional<String> accountId,
                                                             Optional<String> userKey,
                                                             Optional<String> username,
                                                             Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get user property keys

Returns the keys of all properties for a user.

Permissions required:

• Administer Jira global permission, to access the property keys on any user.
• Access to Jira, to access the calling user's property keys.

Note: These user properties are unrelated to the user properties that are set in Jira.

Parameters:

accountId -

The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required.

(optional)

userKey -

This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

(optional)

username -

This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

(optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<PropertyKeys>

setUserProperty

public io.reactivex.Single<Object> setUserProperty(String propertyKey,
                                                   Object body,
                                                   Optional<String> accountId,
                                                   Optional<String> userKey,
                                                   Optional<String> username,
                                                   Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Set user property

Sets the value of a user's property. Use this resource to store custom data against a user.

Permissions required:

• Administer Jira global permission, to set a property on any user.
• Access to Jira, to set a property on the calling user's record.

Note: These user properties are unrelated to the user properties that are set in Jira.

Parameters:

propertyKey -

The key of the user's property. The maximum length is 255 characters.

(required)

body - (required)

accountId -

The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required.

(optional)

userKey -

This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

(optional)

username -

This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

(optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Object>