Class UserProperties

Index

Constructors

constructor

Methods

deleteUserProperty getUserProperty getUserPropertyKeys setUserProperty

Constructors

constructor

new UserProperties(client: Client): Version3.UserProperties
Parameters
- client: Client
Returns Version3.UserProperties
- Defined in src/version3/userProperties.ts:8

Methods

deleteUserProperty

deleteUserProperty<T = void>(
parameters: Version3Parameters.DeleteUserProperty,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteUserProperty
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/userProperties.ts:160
deleteUserProperty<T = void>(
parameters: Version3Parameters.DeleteUserProperty,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteUserProperty
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/userProperties.ts:173

getUserProperty

getUserProperty<T = Version3Models.EntityProperty>(
parameters: Version3Parameters.GetUserProperty,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version3Models.EntityProperty
Parameters
- parameters: Version3Parameters.GetUserProperty
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/userProperties.ts:71
getUserProperty<T = Version3Models.EntityProperty>(
parameters: Version3Parameters.GetUserProperty,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version3Models.EntityProperty
Parameters
- parameters: Version3Parameters.GetUserProperty
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/userProperties.ts:87

getUserPropertyKeys

getUserPropertyKeys<T = Version3Models.PropertyKeys>(
parameters: undefined | Version3Parameters.GetUserPropertyKeys,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version3Models.PropertyKeys
Parameters
- parameters: undefined | Version3Parameters.GetUserPropertyKeys
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/userProperties.ts:22
getUserPropertyKeys<T = Version3Models.PropertyKeys>(
parameters?: Version3Parameters.GetUserPropertyKeys,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version3Models.PropertyKeys
Parameters
- Optionalparameters: Version3Parameters.GetUserPropertyKeys
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/userProperties.ts:38

setUserProperty

setUserProperty<T = unknown>(
parameters: Version3Parameters.SetUserProperty,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.SetUserProperty
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/userProperties.ts:119
setUserProperty<T = unknown>(
parameters: Version3Parameters.SetUserProperty,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.SetUserProperty
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/userProperties.ts:131

Class UserProperties

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.UserProperties

Methods

deleteUserProperty

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getUserProperty

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getUserPropertyKeys

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

setUserProperty

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page