Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

...

...

languagenone

GET

...

http://localhost:9000/api/user_properties

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

...

...

languagenone

GET

...

Response Format

Code Block
titleJSON
languagejavascript
[
  {
    "key":"notification.ChangesInReviewAssignedToMeOrCreatedByMe.EmailNotificationChannel",
    "value":"true"}
  },
  ...
]

Parameters

Parameter

Description

Required

Default ValueExample Value

id

Key of the user property

No

None

notification.ChangesInReviewAssignedToMeOrCreatedByMe.EmailNotificationChannel

formatResponse formatsformat.
Possible values: xml or | json
NoxmlNonejson

Create a User Property

DescriptionCreate a user property

URL

/api/user_properties

HTTP MethodPOST
SecurityRequires Global Administrator role

Examples

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

...

...

languagenone

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 propertyYesNonemyProperty
valueValue of the user propertyNoNonemyValue

Update a User Property

DescriptionUpdate a user property

URL

/api/user_properties

HTTP MethodPUT
SecurityRequires Global Administrator role

Examples

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

...

...

languagenone

curl

...

-u

...

admin:admin

...

-X

...

PUT

...

"http://localhost:9000/api/user_properties/myProperty?value=myValue"

Parameters

Parameter

Description

Required

Default ValueExample Value
keyKey of the user propertyYesNonemyProperty
valueValue of the user propertyYesNonemyValue

Delete a User Property

DescriptionDelete a user property

URL

/api/user_properties

HTTP MethodDELETE
SecurityRequires Global Administrator role

Examples

...

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

...

...

languagenone

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