/api/usersandgroups/users/{userId}/fields

Annotation based user resource.

The endpoint intentionally keeps the dynamic field data in the model instead of making the set of properties depend on installed plugins. Every value is still converted and validated by its registered UserFieldDefinition. Authentication credentials and session fields are never returned or accepted for mutation.

The UserAccountType#Administrator type is internal and private. It represents the single reserved Master account and cannot be used to create another account through this API.

For an existing user, both PUT and PATCH use partial-update semantics: only properties supplied by the request are changed, while omitted properties retain their current values. PUT is not a full replacement.

Returns all safe registered field values available for this account.

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

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

{
    "property": {
        
    }
}

Applies a complete map of registered field values to the staged model.

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

{
    "property": {
        
    }
}

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

{
    "property": {
        
    }
}

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.

Type: object