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.

...

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':

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

Parameters

Parameter

Description

Required

Default Value

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':

    Code Block
    languagenone
    xxxxcurl -u admin:admin -X PUT "http://localhost:9000/api/user_properties/myProperty?value=myValue"

Parameters

Parameter

Description

Required

Default Value

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':

    Code Block
    languagenone
    xxxxcurl -u admin:admin -X DELETE http://localhost:9000/api/user_properties/myProperty

Parameters

Parameter

Description

Required

Default Value

Value

     
keyKey of the user propertyYesNone