Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<div><table class="wysiwyg-macro" data-macro-name="info" data-macro-parameters="icon=false|title=Table of Contents" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2luZm86aWNvbj1mYWxzZXx0aXRsZT1UYWJsZSBvZiBDb250ZW50c30&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body"><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e3RvYzptYXhMZXZlbD0xfQ&amp;locale=en_GB&amp;version=2" data-macro-name="toc" data-macro-parameters="maxLevel=1"></p></td></tr></table><h1>Get a List of User Properties</h1></div><table class="confluenceTable"><tbody><tr><td colspan="1" class="confluenceTd"><strong>Description</strong></td><td colspan="1" class="confluenceTd">Get a list of user properties</td></tr><tr><td class="confluenceTd"><p><strong>URL</strong></p></td><td class="confluenceTd"><p>/api/user_properties</p></td></tr><tr><td colspan="1" class="confluenceTd"><strong>HTTP Method</strong></td><td colspan="1" class="confluenceTd">GET</td></tr><tr><td colspan="1" class="confluenceTd"><strong>Response Formats</strong></td><td colspan="1" class="confluenceTd">json | xml</td></tr><tr><td class="confluenceTd"><p><strong>Security</strong></p></td><td class="confluenceTd"><p>Authentication required</p></td></tr></tbody></table><h3>Examples</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><span style="color: rgb(0,51,102);">Use Case</span></th><th class="confluenceTh"><span style="color: rgb(0,51,102);">Example Request</span></th></tr><tr><td class="confluenceTd">Get all the logged in user's properties</td><td class="confluenceTd"><blockquote><p>GET <a href="http://localhost:9000/api/user_properties">http://localhost:9000/api/user_properties</a></p></blockquote></td></tr><tr><td class="confluenceTd">Get the 'notification.ChangesInReviewAssignedToMeOrCreatedByMe.EmailNotificationChannel' logged in user's property</td><td class="confluenceTd"><blockquote><p>GET <a href="http://localhost:9000/api/user_properties/notification.ChangesInReviewAssignedToMeOrCreatedByMe.EmailNotificationChannel">http://localhost:9000/api/user_properties/notification.ChangesInReviewAssignedToMeOrCreatedByMe.EmailNotificationChannel</a></p></blockquote></td></tr></tbody></table><h3>Response Format</h3><table class="wysiwyg-macro" data-macro-name="code" data-macro-parameters="language=javascript|title=JSON" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGU6dGl0bGU9SlNPTnxsYW5ndWFnZT1qYXZhc2NyaXB0fQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>[
  {
    "key":"notification.ChangesInReviewAssignedToMeOrCreatedByMe.EmailNotificationChannel",
    "value":"true"}
  },
  ...
]</pre></td></tr></table><h3>Parameters</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Parameter</p></th><th class="confluenceTh"><p>Description</p></th><th class="confluenceTh"><p>Required</p></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Default Value</span></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Example Value </span></th></tr><tr><td class="confluenceTd"><p><strong>id</strong></p></td><td class="confluenceTd"><p>Key of the user property</p></td><td class="confluenceTd"><p>No</p></td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd"><p>notification.ChangesInReviewAssignedToMeOrCreatedByMe.EmailNotificationChannel</p></td></tr><tr><td colspan="1" class="confluenceTd"><strong>format</strong></td><td colspan="1" class="confluenceTd"><p>Response format can be set through:</p><ul><li>Parameter format: xml | json</li><li>Or the 'Accept' property in the HTTP header:</li></ul><ul><li><ul><li>Accept:text/xml</li><li>Accept:application/json</li></ul></li></ul><div>If nothing is set, json is used.</div></td><td colspan="1" class="confluenceTd">No</td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">json</td></tr></tbody></table><h1>Create or Update a User Property</h1><table class="confluenceTable"><tbody><tr><td colspan="1" class="confluenceTd"><strong>Description</strong></td><td colspan="1" class="confluenceTd">Create or update a user property</td></tr><tr><td class="confluenceTd"><p><strong>URL</strong></p></td><td class="confluenceTd"><p>/api/user_properties</p></td></tr><tr><td colspan="1" class="confluenceTd"><strong>HTTP Method</strong></td><td colspan="1" class="confluenceTd">POST</td></tr><tr><td class="confluenceTd"><strong>Security</strong></td><td class="confluenceTd">Requires Global Administrator role</td></tr></tbody></table><h3>Examples</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><span style="color: rgb(0,51,102);">Use Case</span></th><th class="confluenceTh"><span style="color: rgb(0,51,102);">Example Request</span></th></tr><tr><td class="confluenceTd">Create property 'myProperty' with value 'myValue' for user 'admin/admin'</td><td class="confluenceTd"><blockquote><p>curl -u admin:admin -d &quot;key=myProperty&amp;value=myValue&quot; -X POST http://localhost:9000/api/user_properties</p></blockquote></td></tr></tbody></table><h3>Parameters</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Parameter</p></th><th class="confluenceTh"><p>Description</p></th><th class="confluenceTh"><p>Required</p></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Default Value</span></th></tr><tr><td class="confluenceTd"><strong>key</strong></td><td class="confluenceTd">Key of the user property</td><td class="confluenceTd">Yes</td><td colspan="1" class="confluenceTd">myProperty</td></tr><tr><td colspan="1" class="confluenceTd"><strong>value</strong></td><td colspan="1" class="confluenceTd">Value of the user property</td><td colspan="1" class="confluenceTd">No</td><td colspan="1" class="confluenceTd">myValue</td></tr></tbody></table><h1>Delete a User Property</h1><table class="confluenceTable"><tbody><tr><td colspan="1" class="confluenceTd"><strong>Description</strong></td><td colspan="1" class="confluenceTd">Delete a user property</td></tr><tr><td class="confluenceTd"><p><strong>URL</strong></p></td><td class="confluenceTd"><p>/api/user_properties</p></td></tr><tr><td colspan="1" class="confluenceTd"><strong>HTTP Method</strong></td><td colspan="1" class="confluenceTd">DELETE</td></tr><tr><td class="confluenceTd"><strong>Security</strong></td><td class="confluenceTd">Requires Global Administrator role</td></tr></tbody></table><h3>Examples</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><span style="color: rgb(0,51,102);">Use Case</span></th><th class="confluenceTh"><span style="color: rgb(0,51,102);">Example Request</span></th></tr><tr><td class="confluenceTd">Update property 'myProperty' with value 'myValue' for user 'admin/admin'</td><td class="confluenceTd"><blockquote><p>curl -u admin:admin -X DELETE http://localhost:9000/api/user_properties/myProperty</p></blockquote></td></tr></tbody></table><h3>Parameters</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Parameter</p></th><th class="confluenceTh"><p>Description</p></th><th class="confluenceTh"><p>Required</p></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Default Value</span></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Example Value</span></th></tr><tr><td class="confluenceTd"><strong>key</strong></td><td class="confluenceTd">Key of the user property</td><td class="confluenceTd">Yes</td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">myProperty</td></tr></tbody></table>