Skip to content

Function: deleteUserProperty() ​

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

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

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.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ accountId?: string; propertyKey: string; }-
parameters.accountId?stringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
parameters.propertyKey?stringThe key of the user's property.
options?RequestOptions-

Returns ​

Promise<void>