Link Search Menu Expand Document Documentation Menu
Documentation

You're viewing version 3.8 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Patch Users API

Introduced 1.0

Updates internal users without replacing them. Specify a user name to update individual attributes of one user, or omit the user name to create, update, or delete multiple users in a single call.

Endpoints

PATCH /_plugins/_security/api/internalusers

PATCH /_plugins/_security/api/internalusers/{username}

Path parameters

The following table lists the available path parameters.

Parameter Data type Required Description
username String No The name of the user to update. If omitted, the request can modify multiple users.

Request body fields

The request body is required. It is an array of JSON objects. Each object contains the following fields.

Field Data type Description Required
op String The operation to perform. Valid values are add, remove, replace, move, copy, and test. Yes
path String The path to modify. When you specify a user name, the path is relative to that user, such as /backend_roles. When you omit the user name, the path names the user, such as /spock. Yes
value Object The new value. Required for the add, replace, and test operations. No

Example request

The following request updates the backend roles of the kirk user:

PATCH _plugins/_security/api/internalusers/kirk
[
  {
    "op": "replace",
    "path": "/backend_roles",
    "value": [
      "commander"
    ]
  }
]

The following request adds the spock and worf users and removes the riker user:

PATCH _plugins/_security/api/internalusers
[
  {
    "op": "add",
    "path": "/spock",
    "value": {
      "password": "Str0ngPassw0rd_7741!",
      "backend_roles": [
        "science"
      ]
    }
  },
  {
    "op": "add",
    "path": "/worf",
    "value": {
      "password": "Str0ngPassw0rd_3390!",
      "backend_roles": [
        "security"
      ]
    }
  },
  {
    "op": "remove",
    "path": "/riker"
  }
]

Example response

When you update one user, the response contains the user name:

{
  "status": "OK",
  "message": "'kirk' updated."
}

When you update multiple users, the response appears as follows:

{
  "status": "OK",
  "message": "Resource updated."
}
350 characters left

Have a question? .

Want to contribute? or .