Disable users

PUT /_security/user/{username}/_disable
Api key auth Basic auth Bearer auth

Disable users in the native realm. By default, when you create users, they are enabled. You can use this API to revoke a user's access to Elasticsearch.

Path parameters

  • username string Required

    An identifier for the user.

Query parameters

  • refresh string

    If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes.

    Values are true, false, or wait_for.

Responses

  • 200 application/json
PUT /_security/user/{username}/_disable 
curl \
 --request PUT 'http://api.example.com/_security/user/{username}/_disable' \
 --header "Authorization: $API_KEY"