getUserProperty
Looking for the documentation on the newest versions of SIL Engine and the Simple Issue Language for Jira 8 for Server/Data Center? Click here !
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
getUserProperty(user, property)
Description
Retrieves properties of users created and maintained in Jira (user properties).Cloud Description
Retrieves 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 get the property for. |
| property | String | yes | Key of the property. |
Cloud Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
user | String | Yes | The userkey of the user. |
| property | String | yes | Key of the property. |
Return type
string
Returns the value of the specified property. If the user does not have the property, it will return an empty string.
Example
return getUserProperty("testuser", "phone");
Notes
The look-up is first made after the userkey, then after the username.
Cloud Notes
On cloud the look-up is made only after the userkey.
See also