Cloud

Jira Cloud platform / Reference / REST API v3

Other operations

Postman Collection

OpenAPI

Operations

GET/rest/api/3/user/nav4-opt-property/{propertyKey}PUT/rest/api/3/user/nav4-opt-property/{propertyKey}

GET

Get user nav property

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.

Data Security Policy: Exempt from app access rules

Scopes

OAuth 2.0 scopes required:

ClassicRECOMMENDED:read:jira-user

Granular:read:user.property:jira

Connect app scope required: READ

Request

Path parameters

propertyKey

string

Required

Query parameters

accountId

string

Responses

Returned if the request is successful.

application/json

UserNavPropertyJsonBean

GET/rest/api/3/user/nav4-opt-property/{propertyKey}

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asUser().requestJira(route`/rest/api/3/user/nav4-opt-property/{propertyKey}?accountId=5b10ac8d82e05b22cc7d4ef5`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

200Response

{
  "key": "<string>",
  "value": "<string>"
}

PUT

Set user nav property

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.

Data Security Policy: Exempt from app access rules

Scopes

OAuth 2.0 scopes required:

ClassicRECOMMENDED:write:jira-work

Granular:write:user.property:jira

Connect apps cannot access this REST resource.

Request

Path parameters

propertyKey

string

Required

Query parameters

accountId

string

Request bodyapplication/json

The value of the property. The value has to be a boolean JSON value. The maximum length of the property value is 32768 bytes.

any

Responses

Returned if the user property is updated/created.

application/json

any

PUT/rest/api/3/user/nav4-opt-property/{propertyKey}

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

var bodyData = `{}`;

const response = await api.asUser().requestJira(route`/rest/api/3/user/nav4-opt-property/{propertyKey}?accountId=5b10ac8d82e05b22cc7d4ef5`, {
  method: 'PUT',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
  body: bodyData
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());