Create or Update User API

Introduced 1.0

Creates or replaces the specified user. You must specify either password (plain text) or hash (the hashed user password). If you specify password, the Security plugin automatically hashes the password before storing it.

Note that any role you supply in the opendistro_security_roles array must already exist for the Security plugin to map the user to that role. To see predefined roles, refer to the list of predefined roles. For instructions on how to create a role, see Create or Update Role API.

Endpoints

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

Request body fields

The request body is required. It is a JSON object with the following fields.

Example request

PUT _plugins/_security/api/internalusers/kirk
{
  "password": "Str0ngPassw0rd_9182!",
  "opendistro_security_roles": [
    "maintenance_staff",
    "database_manager"
  ],
  "backend_roles": [
    "captain",
    "starfleet"
  ],
  "attributes": {
    "attribute1": "value1",
    "attribute2": "value2"
  }
}

Example response

{
  "status": "CREATED",
  "message": "'kirk' created."
}