Full documentation for SonarQube has moved to a new location: http://docs.sonarqube.org/display/SONAR

Versions Compared

Key

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

...

Parameter

Description

Required

Default ValueExample Value

id

Key of the user property

No

None

notification.ChangesInReviewAssignedToMeOrCreatedByMe.EmailNotificationChannel

format

Response format

.
Possible values

can be set through:

  • Parameter format: xml | json
  • Or the 'Accept' property in the HTTP header:
    • Accept:text/xml
    • Accept:application/json
If nothing is set, json is used.
NoNonejson

Create or Update a User Property

DescriptionCreate or update a user property

URL

/api/user_properties

HTTP MethodPOST
SecurityRequires Global Administrator roleAdminister System permission

Examples

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

curl -u admin:admin -d "key=myProperty&value=myValue" -X POST http://localhost:9000/api/user_properties

...

Parameter

Description

Required

Default Value
keyKey of the user propertyYesmyProperty
valueValue of the user propertyNomyValue

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'

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 roleAdminister System permission

Examples

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

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