| Description | Get a list of user properties |
URL | /api/user_properties |
| HTTP Method | GET |
| Response Formats | json | xml |
Security | Authentication required |
| Use Case | Example Request |
|---|---|
| Get all the logged in user's properties | |
| Get the 'notification.ChangesInReviewAssignedToMeOrCreatedByMe.EmailNotificationChannel' logged inĀ user's property |
[
{
"key":"notification.ChangesInReviewAssignedToMeOrCreatedByMe.EmailNotificationChannel",
"value":"true"}
},
...
] |
Parameter | Description | Required | Default Value | Example Value |
|---|---|---|---|---|
id | Key of the user property | No | None | notification.ChangesInReviewAssignedToMeOrCreatedByMe.EmailNotificationChannel |
| format | Response format can be set through:
If nothing is set, json is used. | No | None | json |
| Description | Create or update a user property |
URL | /api/user_properties |
| HTTP Method | POST |
| Security | Requires Global Administrator role |
| Use Case | Example Request |
|---|---|
| Create property 'myProperty' with value 'myValue' for user 'admin/admin' |
|
Parameter | Description | Required | Default Value |
|---|---|---|---|
| key | Key of the user property | Yes | myProperty |
| value | Value of the user property | No | myValue |
| Description | Delete a user property |
URL | /api/user_properties |
| HTTP Method | DELETE |
| Security | Requires Global Administrator role |
| Use Case | Example Request |
|---|---|
| Update property 'myProperty' with value 'myValue' for user 'admin/admin' |
|
Parameter | Description | Required | Default Value | Example Value |
|---|---|---|---|---|
| key | Key of the user property | Yes | None | myProperty |