user_patch

Patch a user.

The difference between the update and patch methods is that the patch will perform an update of the provided parameters, while leaving all other parameters unchanged, whereas the update methods deletes all parameters not explicitly provided in the data_dict.

Authorization

apiTokenHeader

Authorization<token>

CKAN API token

In: header

Request Body

application/json

id?string

the name or id of the user

name?string

the name of the new user, a string between 2 and 100 characters long, containing only lowercase alphanumeric characters, -, and _

email?string

the email address for the new user

password?string

the password of the new user, a string of at least 4 characters

fullname?string

the full name of the new user

about?string

a description of the new user

image_url?string

the URL to an image to be displayed on the user's page

plugin_extras?

private extra user data belonging to plugins. Only sysadmin users may set this value. It should be a dict that can be dumped into JSON, and plugins should namespace their extras with the plugin name to avoid collisions with other plugins, e.g.:

{
    "name": "test_user",
    "email": "test@example.com",
    "plugin_extras": {
        "my_plugin": {
            "private_extra": 1
        },
        "another_plugin": {
            "another_extra": True
        }
    }
}

with_apitoken?boolean

whether to create an API token for the user

curl -X PATCH "http://localhost:5000/api/3/action/user_patch" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X PATCH "http://localhost:5000/api/3/action/user_patch" \  -H "Content-Type: application/json" \  -d '{}'