| Warning |
|---|
This documentation assumes basic knowledge of REST API, Authorization mechanisms, and Web Browser Network Tools. |
Get JWT
Visit the Configuration Page for Secure Fields for some project.
Open Network Tools
https://developer.chrome.com/docs/devtools/network
Find Search Request
- In "Filter" input paste: public/app/rest/api/v1/secure-field/project-configuration/search
2. Will be your example REST API request that loads Project Configuration of Secure Fields
Get JWT Token from the Authorization Header
This value, JWT, and many characters will be your Authorization Token, which is required to perform REST API calls with cUrl/Posman/Scripts. The JWT token is valid only for 2 hours! After that time, you need to repeat this procedure and get a new one.
Check with Postman
An example is Based on the Postman tool—https://www.postman.com—but it can easily be adjusted for any REST API Client.
Open Postman and create a new Request
Copy/Paste Search the Request URL to Postman
Copy/Paste JWT Token to Postman
Add Authorization Header with value of obtained JWT Token (remember to include prefix "JWT")
Execute Request
Your response from Postman Should be exactly the same as response in WebBrowser
Web Browser Response
Postman Response
Configuration endpoints docs and explanation
Secure Fields are organized in two levels of configuration: Global Configuration and Project Configuration.
Global Configuration
Global defines Secure Fields: id, name, and type. It limits the number of Secure Fields with a particular name to one. Secure Fields' names are unique across the whole Jira instance.
Project Configuration
Project Configuration is an instance of a Secure Field within your particular project (and issue type). Within the project configuration, you define permissions, option values, etc.
By default, Global Configuration Endpoints are not required. The creation of project configurations creates global ones.
GET /public/app/rest/api/v1/secure-field/project-configuration/search
POST /public/app/rest/api/v1/secure-field/project-configuration
PUT /public/app/rest/api/v1/secure-field/project-configuration/{id}
DELETE /public/app/rest/api/v1/secure-field/project-configuration/{id}
