User field settings
/api/usersandgroups/user-fields/{key}/key
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.
GET /api/usersandgroups/user-fields/{key}/key
Public field key, also accepted in create and update request bodies.
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
key |
path | string |
yes | setting key from the URL |
Response
| Status | Content Type | Schema | Description |
|---|---|---|---|
200 |
application/json |
string |
Successful response. |
Example Request
# Request GET /api/usersandgroups/user-fields/<key>/key HTTP/1.1 Accept: application/json Authorization: Bearer <access-token> # Response HTTP/1.1 200 OK Content-Type: application/json "string"
PUT /api/usersandgroups/user-fields/{key}/key
Public field key, also accepted in create and update request bodies.
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
key |
path | string |
yes | setting key from the URL |
Request Body
| Content Type | Schema | Required | Description |
|---|---|---|---|
application/json |
string |
yes |
Public field key, also accepted in create and update request bodies. |
Response
| Status | Content Type | Schema | Description |
|---|---|---|---|
200 |
application/json |
string |
Successful response. |
Example Request
# Request PUT /api/usersandgroups/user-fields/<key>/key HTTP/1.1 Accept: application/json Authorization: Bearer <access-token> Content-Type: application/json "string" # Response HTTP/1.1 200 OK Content-Type: application/json "string"
Common Error Responses
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": []
}
Schemas
Request and response schemas used on this page.
ApiError
| Property | Type | Required | Description |
|---|---|---|---|
status |
integer (int32) |
yes | — |
code |
string |
yes | — |
message |
string |
yes | — |
details |
array<object> |
no | — |