/api/usersandgroups/user-fields/{key}/properties

Exposes user field settings through the annotation-based WebAPI.

The public representation deliberately contains only scalar metadata and a flat property map. In particular, the manager's internal nature and field implementation are never returned to a client. The map is produced by GenericFieldSetting#toMap and therefore contains generic, user-field-specific, and extension-specific values required for a lossless round trip. Registration of this class is intentionally performed by the owning server plugin.

Complete flat setting properties. Values are strings because this is the format required by UserFieldSettingsManager; JSON-encoded values remain JSON strings in this map.

# Request
GET /api/usersandgroups/user-fields/<key>/properties HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>

# Response
HTTP/1.1 200 OK
Content-Type: application/json

{
    "property": "string"
}

Complete flat setting properties. Values are strings because this is the format required by UserFieldSettingsManager; JSON-encoded values remain JSON strings in this map.

# Request
PUT /api/usersandgroups/user-fields/<key>/properties HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>
Content-Type: application/json

{
    "property": "string"
}

# Response
HTTP/1.1 200 OK
Content-Type: application/json

{
    "property": "string"
}

The status codes 400, 403, 404, 405, 406, 409, 413, 415, and 500 use the same ApiError JSON error format:

{
    "status": 404,
    "code": "route_not_found",
    "message": "The requested API route does not exist.",
    "details": []
}

Request and response schemas used on this page.