Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Table of Contents

Get a List of User Properties

DescriptionGet a list of user properties

URL

/api/user_properties

MethodGET

Security

Authentication required

Examples

  1. Get all the logged in user's properties:



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

Parameters

Parameter

Description

Required

Default Value

id

Key of the user property

No

None
formatResponse formats: xml or jsonNoxml

Create a User Property

DescriptionCreate a user property

URL

/api/user_properties

MethodPOST
SecurityRequires Global Administrator role

Examples

  1. Create property 'myProperty' with value 'myValue' for user 'admin/admin':

Parameters

Parameter

Description

Required

Default Value
keyKey of the user propertyYesNone
valueValue of the user propertyNoNone

Update a User Property

DescriptionUpdate a user property

URL

/api/user_properties

MethodPUT
SecurityRequires Global Administrator role

Examples

  1. Update property 'myProperty' with value 'myValue' for user 'admin/admin':

Parameters

Parameter

Description

Required

Default Value
keyKey of the user propertyYesNone
valueValue of the user propertyYesNone

Delete a User Property

DescriptionDelete a user property

URL

/api/user_properties

MethodDELETE
SecurityRequires Global Administrator role

Examples

  1. Delete property 'myProperty' for user 'admin/admin':

Parameters

Parameter

Description

Required

Default Value
keyKey of the user propertyYesNone
  • No labels