Module user_properties_api

Structs

DeleteUserPropertyParams

struct for passing parameters to the method delete_user_property

GetUserPropertyKeysParams

struct for passing parameters to the method get_user_property_keys

GetUserPropertyParams

struct for passing parameters to the method get_user_property

SetUserPropertyParams

struct for passing parameters to the method set_user_property

Enums

DeleteUserPropertyError

struct for typed errors of method delete_user_property

GetUserPropertyError

struct for typed errors of method get_user_property

GetUserPropertyKeysError

struct for typed errors of method get_user_property_keys

SetUserPropertyError

struct for typed errors of method set_user_property

Functions

delete_user_property

Deletes a property from a user. Note: This operation does not access the user properties created and maintained in Jira. 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.

get_user_property

Returns the value of a user’s property. If no property key is provided Get user property keys is called. Note: This operation does not access the user properties created and maintained in Jira. 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.

get_user_property_keys

Returns the keys of all properties for a user. Note: This operation does not access the user properties created and maintained in Jira. 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.

set_user_property

Sets the value of a user’s property. Use this resource to store custom data against a user. Note: This operation does not access the user properties created and maintained in Jira. 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.