...
| Description | Get a list of user properties |
URL | /api/user_properties |
| HTTP Method | GET |
| Response Formats | json | xml |
Security | Authentication required |
Examples
| Use Case | Example Request |
|---|---|
| Get all the logged in user's properties |
...
...
| language | none |
|---|
|
...
| Get the 'notification.ChangesInReviewAssignedToMeOrCreatedByMe.EmailNotificationChannel' logged in user's property |
...
...
| language | none |
|---|
|
...
Response Format
| Code Block | ||||
|---|---|---|---|---|
| ||||
[
{
"key":"notification.ChangesInReviewAssignedToMeOrCreatedByMe.EmailNotificationChannel",
"value":"true"}
},
...
] |
Parameters
Parameter | Description | Required | Default Value | Example Value |
|---|---|---|---|---|
id | Key of the user property | No | None | notification.ChangesInReviewAssignedToMeOrCreatedByMe.EmailNotificationChannel |
| format | Response formatsformat. Possible values: xml or | json | No | xmlNone | json |
Create a User Property
| Description | Create a user property |
URL | /api/user_properties |
| HTTP Method | POST |
| Security | Requires Global Administrator role |
Examples
| Use Case | Example Request |
|---|---|
| Create property 'myProperty' with value 'myValue' for user 'admin/admin' |
...
...
| language | none |
|---|
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
Parameters
Parameter | Description | Required | Default Value |
|---|---|---|---|
| key | Key of the user property | Yes | NonemyProperty |
| value | Value of the user property | No | NonemyValue |
Update a User Property
| Description | Update a user property |
URL | /api/user_properties |
| HTTP Method | PUT |
| Security | Requires Global Administrator role |
Examples
| Use Case | Example Request |
|---|---|
| Update property 'myProperty' with value 'myValue' for user 'admin/admin' |
...
...
| language | none |
|---|
|
...
|
...
|
...
|
...
|
...
|
Parameters
Parameter | Description | Required | Default Value | Example Value |
|---|---|---|---|---|
| key | Key of the user property | Yes | None | myProperty |
| value | Value of the user property | Yes | None | myValue |
Delete a User Property
| Description | Delete a user property |
URL | /api/user_properties |
| HTTP Method | DELETE |
| Security | Requires Global Administrator role |
Examples
...
| Use Case | Example Request |
|---|---|
| Update property 'myProperty' with value 'myValue' for user 'admin/admin' |
...
...
| language | none |
|---|
|
...
|
...
|
...
|
...
|
...
|
Parameters
Parameter | Description | Required | Default Value | Example Value |
|---|---|---|---|---|
| key | Key of the user property | Yes | None | myProperty |
