You are viewing an old version of this page. View the current version.
Compare with Current ·
View Page History
| Table of Contents |
Get a List of User Properties
| Description | Get a list of user properties |
URL | /api/user_properties |
| Method | GET |
Security | Authentication required |
Examples
Get all the logged in user's properties:
Get the 'notification.ChangesInReviewAssignedToMeOrCreatedByMe.EmailNotificationChannel' logged in user's property:
Parameters
Parameter | Description | Required | Default Value |
|---|---|---|---|
id | Key of the user property | No | None |
| format | Response formats: xml or json | No | xml |
Create a User Property
| Description | Create a user property |
URL | /api/user_properties |
| Method | POST |
| Security | Requires Global Administrator role |
Examples
Create property 'myProperty' with value 'myValue' for user 'admin/admin':
Parameters
Parameter | Description | Required | Default Value |
|---|---|---|---|
| key | Key of the user property | Yes | None |
| value | Value of the user property | No | None |
Update a User Property
| Description | Update a user property |
URL | /api/user_properties |
| Method | PUT |
| Security | Requires Global Administrator role |
Examples
Update property 'myProperty' with value 'myValue' for user 'admin/admin':
Parameters
Parameter | Description | Required | Default Value |
|---|---|---|---|
| key | Key of the user property | Yes | None |
| value | Value of the user property | Yes | None |
Delete a User Property
| Description | Delete a user property |
URL | /api/user_properties |
| Method | DELETE |
| Security | Requires Global Administrator role |
Examples
Delete property 'myProperty' for user 'admin/admin':
Parameters
Parameter | Description | Required | Default Value |
|---|---|---|---|
| key | Key of the user property | Yes | None |
Labels
