Skip to content

Function: getUserPropertyKeys() ​

ts
function getUserPropertyKeys(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  keys?: object[];
}>;

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

Returns the keys of all properties for a user.

Note: This operation does not access the user properties created and maintained in Jira.

Permissions required:

  • Administer Jira global permission, to access the property keys on any user.
  • Access to Jira, to access the calling user's property keys.

Parameters ​

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

Returns ​

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