Class UsernavpropertiesService

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-usernavproperties

Hierarchy

CommonHttpService
- UsernavpropertiesService

Index

Constructors

Methods

getUserNavProperty setUserNavProperty initialize

Constructors

constructor

new UsernavpropertiesService(getClientInstance): UsernavpropertiesService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns UsernavpropertiesService
Inherited from CommonHttpService.constructor

Methods

getUserNavProperty

getUserNavProperty(params): Promise<UserNavPropertyJsonBean>
Returns the value of a user nav preference.

Note: This operation fetches the property key value directly from RbacClient.

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.
Parameters
- params: {
  accountId?: string;
  propertyKey: string;
  }
  - OptionalaccountId?: string
    The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
  - propertyKey: string
    The key of the user's property.
Returns Promise<UserNavPropertyJsonBean>
Returned if the request is successful.

Path
GET /rest/api/3/user/nav4-opt-property/{propertyKey} @scopes-current read:jira-user @scopes-beta read:user.property:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-usernavproperties#api-rest-api-3-user-nav4-opt-property-propertykey-get

setUserNavProperty

setUserNavProperty(params): Promise<unknown>
Sets the value of a Nav4 preference. Use this resource to store Nav4 preference data against a user in the Identity service.

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
- params: {
      accountId?: string;
      propertyKey: string;
      requestBody: unknown;
  }
  - OptionalaccountId?: string
    The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
  - propertyKey: string
    The key of the nav property. The maximum length is 255 characters.
  - requestBody: unknown
    The value of the property. The value has to be a boolean JSON value. The maximum length of the property value is 32768 bytes.
Returns Promise<unknown>
Returned if the user property is updated/created.

Path
PUT /rest/api/3/user/nav4-opt-property/{propertyKey} @scopes-current write:jira-work @scopes-beta write:user.property:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-usernavproperties#api-rest-api-3-user-nav4-opt-property-propertykey-put

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize