Function: getUserProperty()

function getUserProperty(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  key?: string;
  value?: unknown;
}>;

Defined in: src/cloud/api/userProperties.ts:52

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.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ accountId?: string; propertyKey: string; }	-
parameters.accountId?	string	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
parameters.propertyKey?	string	The key of the user's property.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>