Get a List of User Properties

DescriptionGet a list of user properties

URL

/api/user_properties

HTTP MethodGET
Response Formatsjson | xml

Security

Authentication required

Examples

Use CaseExample Request
Get all the logged in user's properties

GET http://localhost:9000/api/user_properties

Get the 'notification.ChangesInReviewAssignedToMeOrCreatedByMe.EmailNotificationChannel' logged inĀ user's property

GET http://localhost:9000/api/user_properties/notification.ChangesInReviewAssignedToMeOrCreatedByMe.EmailNotificationChannel

Response Format

[
  {
    "key":"notification.ChangesInReviewAssignedToMeOrCreatedByMe.EmailNotificationChannel",
    "value":"true"}
  },
  ...
]

Parameters

Parameter

Description

Required

Default ValueExample Value

id

Key of the user property

No

None

notification.ChangesInReviewAssignedToMeOrCreatedByMe.EmailNotificationChannel

format

Response format can be set through:

  • Parameter format: xml | json
  • Or the 'Accept' property in the HTTP header:
    • Accept:text/xml
    • Accept:application/json
If nothing is set, json is used.
NoNonejson

Create or Update a User Property

DescriptionCreate or update a user property

URL

/api/user_properties

HTTP MethodPOST
SecurityRequires Administer System permission

Examples

Use CaseExample Request
Create property 'myProperty' with value 'myValue' for user 'admin/admin'

curl -u admin:admin -d "key=myProperty&value=myValue" -X POST http://localhost:9000/api/user_properties

Parameters

Parameter

Description

Required

Default Value
keyKey of the user propertyYesmyProperty
valueValue of the user propertyNomyValue

Delete a User Property

DescriptionDelete a user property

URL

/api/user_properties

HTTP MethodDELETE
SecurityRequires Administer System permission

Examples

Use CaseExample Request
Update property 'myProperty' with value 'myValue' for user 'admin/admin'

curl -u admin:admin -X DELETE http://localhost:9000/api/user_properties/myProperty

Parameters

Parameter

Description

Required

Default ValueExample Value
keyKey of the user propertyYesNonemyProperty