Skip to end of metadata
Go to start of metadata

Cprime Apps has been rebranded as Anova Apps. Please note the only effect is the company name - all of our products’ names, logos, functionalities, support, etc. is exactly the same. The new location to our documentation space is https://anovaapps.atlassian.net.

The availability of the users personal data may be impacted by the recent changes by Atlassian in order to meet GDPR compliance. See the following for more information:


Availability

  • This routine is available starting with katl-commons 2.0.7 for Jira 5.x or katl-commons 1.1.14 for Jira 4.3.x/4.4.x.
  • This routine is available for Jira server and cloud deployment options.

Syntax

setUserProperty(user, propertyKey, propertyValue)

Description

Sets properties of users created and maintained in Jira (user properties).

If the property does not exist, it will be created.

Cloud Description

Sets properties of users only accessible through requests. This set of user properties have nothing to do with the user properties created and maintained in Jira (they can't even be accessed through requests).

Parameters

Parameter name

Type

Required

Description

user

String

Yes

Username or userkey to set the property for.

propertyKeyStringYesKey of the property.
propertyValueStringYesValue to set for the property.

Cloud Parameters

Parameter name

Type

Required

Description

user

String

Yes

Userkey to set the property for.

propertyKeyStringYesKey of the property.
propertyValueStringYesValue to set for the property.

Return type

none

The returned value has no meaning.

Example

setUserProperty("testuser", "phone", "987 654 3210");

Notes

The look-up is first made after the userkey, then after the username.

Cloud Notes

The look-up is made after the userkey.

See also