Function: setUserProperty()

function setUserProperty(
   client, 
   parameters, 
   options?
): Promise<void>;

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

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.

Parameters

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

Returns

Promise<void>