/** * The Jira Cloud platform REST API * Jira Cloud platform REST API documentation * * The version of the OpenAPI document: 1001.0.0-SNAPSHOT * Contact: ecosystem@atlassian.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import { EntityProperty, PropertyKeys } from '../models'; export interface DeleteUserPropertyRequest { propertyKey: string; accountId?: string; userKey?: string; username?: string; } export interface GetUserPropertyRequest { propertyKey: string; accountId?: string; userKey?: string; username?: string; } export interface GetUserPropertyKeysRequest { accountId?: string; userKey?: string; username?: string; } export interface SetUserPropertyRequest { propertyKey: string; body: object; accountId?: string; userKey?: string; username?: string; } /** * no description */ export declare class UserPropertiesApi extends runtime.BaseAPI { /** * Deletes a property from a user. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to delete a property from any user. * Access to Jira, to delete a property from the calling user\'s record. Note: These user properties are unrelated to the [user properties](https://confluence.atlassian.com/x/74xjL) that are set in Jira. * Delete user property */ deleteUserPropertyRaw(requestParameters: DeleteUserPropertyRequest): Promise>; /** * Deletes a property from a user. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to delete a property from any user. * Access to Jira, to delete a property from the calling user\'s record. Note: These user properties are unrelated to the [user properties](https://confluence.atlassian.com/x/74xjL) that are set in Jira. * Delete user property */ deleteUserProperty(requestParameters: DeleteUserPropertyRequest): Promise; /** * Returns the value of a user\'s property. If no property key is provided [Get user property keys](#api-rest-api-3-user-properties-get) is called. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to get a property from any user. * Access to Jira, to get a property from the calling user\'s record. Note: These user properties are unrelated to the [user properties](https://confluence.atlassian.com/x/74xjL) that are set in Jira. * Get user property */ getUserPropertyRaw(requestParameters: GetUserPropertyRequest): Promise>; /** * Returns the value of a user\'s property. If no property key is provided [Get user property keys](#api-rest-api-3-user-properties-get) is called. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to get a property from any user. * Access to Jira, to get a property from the calling user\'s record. Note: These user properties are unrelated to the [user properties](https://confluence.atlassian.com/x/74xjL) that are set in Jira. * Get user property */ getUserProperty(requestParameters: GetUserPropertyRequest): Promise; /** * Returns the keys of all properties for a user. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to access the property keys on any user. * Access to Jira, to access the calling user\'s property keys. Note: These user properties are unrelated to the [user properties](https://confluence.atlassian.com/x/8YxjL) that are set in Jira. * Get user property keys */ getUserPropertyKeysRaw(requestParameters: GetUserPropertyKeysRequest): Promise>; /** * Returns the keys of all properties for a user. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to access the property keys on any user. * Access to Jira, to access the calling user\'s property keys. Note: These user properties are unrelated to the [user properties](https://confluence.atlassian.com/x/8YxjL) that are set in Jira. * Get user property keys */ getUserPropertyKeys(requestParameters: GetUserPropertyKeysRequest): Promise; /** * Sets the value of a user\'s property. Use this resource to store custom data against a user. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to set a property on any user. * Access to Jira, to set a property on the calling user\'s record. Note: These user properties are unrelated to the [user properties](https://confluence.atlassian.com/x/8YxjL) that are set in Jira. * Set user property */ setUserPropertyRaw(requestParameters: SetUserPropertyRequest): Promise>; /** * Sets the value of a user\'s property. Use this resource to store custom data against a user. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to set a property on any user. * Access to Jira, to set a property on the calling user\'s record. Note: These user properties are unrelated to the [user properties](https://confluence.atlassian.com/x/8YxjL) that are set in Jira. * Set user property */ setUserProperty(requestParameters: SetUserPropertyRequest): Promise; }