IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Elasticsearch\Namespaces\SearchableSnapshotsNamespace Elasticsearch\Namespaces\SlmNamespace »
Elastic Docs ›Elasticsearch PHP Client [7.17] ›Reference - Endpoints

Elasticsearch\Namespaces\SecurityNamespace

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Elasticsearch\Namespaces\SecurityNamespace

edit

Class SecurityNamespace

Description

this file is autogenerated using util/GenerateEndpoints.php and Elasticsearch 7.12.1 (3186837139b9c6b6d23c3200870651f10d3343b7)

Methods

The class defines the following methods:

authenticate(array $params = [])

/*
*/

changePassword(array $params = [])

/*
$params['username'] = (string) The username of the user to change the password for
$params['refresh']  = (enum) 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. (Options = true,false,wait_for)
$params['body']     = (array) the new password for the user (Required)
*/

clearApiKeyCache(array $params = [])

/*
$params['ids'] = (list) A comma-separated list of IDs of API keys to clear from the cache
*/

clearCachedPrivileges(array $params = [])

/*
$params['application'] = (list) A comma-separated list of application names
*/

clearCachedRealms(array $params = [])

/*
$params['realms']    = (list) Comma-separated list of realms to clear
$params['usernames'] = (list) Comma-separated list of usernames to clear from the cache
*/

clearCachedRoles(array $params = [])

/*
$params['name'] = (list) Role name
*/

createApiKey(array $params = [])

/*
$params['refresh'] = (enum) 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. (Options = true,false,wait_for)
$params['body']    = (array) The api key request to create an API key (Required)
*/

deletePrivileges(array $params = [])

/*
$params['application'] = (string) Application name
$params['name']        = (string) Privilege name
$params['refresh']     = (enum) 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. (Options = true,false,wait_for)
*/

deleteRole(array $params = [])

/*
$params['name']    = (string) Role name
$params['refresh'] = (enum) 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. (Options = true,false,wait_for)
*/

deleteRoleMapping(array $params = [])

/*
$params['name']    = (string) Role-mapping name
$params['refresh'] = (enum) 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. (Options = true,false,wait_for)
*/

deleteUser(array $params = [])

/*
$params['username'] = (string) username
$params['refresh']  = (enum) 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. (Options = true,false,wait_for)
*/

disableUser(array $params = [])

/*
$params['username'] = (string) The username of the user to disable
$params['refresh']  = (enum) 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. (Options = true,false,wait_for)
*/

enableUser(array $params = [])

/*
$params['username'] = (string) The username of the user to enable
$params['refresh']  = (enum) 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. (Options = true,false,wait_for)
*/

getApiKey(array $params = [])

/*
$params['id']         = (string) API key id of the API key to be retrieved
$params['name']       = (string) API key name of the API key to be retrieved
$params['username']   = (string) user name of the user who created this API key to be retrieved
$params['realm_name'] = (string) realm name of the user who created this API key to be retrieved
$params['owner']      = (boolean) flag to query API keys owned by the currently authenticated user (Default = false)
*/

getBuiltinPrivileges(array $params = [])

/*
*/

getPrivileges(array $params = [])

/*
$params['application'] = (string) Application name
$params['name']        = (string) Privilege name
*/

getRole(array $params = [])

/*
$params['name'] = (list) A comma-separated list of role names
*/

getRoleMapping(array $params = [])

/*
$params['name'] = (list) A comma-separated list of role-mapping names
*/

getToken(array $params = [])

/*
$params['body'] = (array) The token request to get (Required)
*/

getUser(array $params = [])

/*
$params['username'] = (list) A comma-separated list of usernames
*/

getUserPrivileges(array $params = [])

/*
*/

grantApiKey(array $params = [])

/*
$params['refresh'] = (enum) 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. (Options = true,false,wait_for)
$params['body']    = (array) The api key request to create an API key (Required)
*/

hasPrivileges(array $params = [])

/*
$params['user'] = (string) Username
$params['body'] = (array) The privileges to test (Required)
*/

invalidateApiKey(array $params = [])

/*
*/

invalidateToken(array $params = [])

/*
$params['body'] = (array) The token to invalidate (Required)
*/

putPrivileges(array $params = [])

/*
$params['refresh'] = (enum) 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. (Options = true,false,wait_for)
$params['body']    = (array) The privilege(s) to add (Required)
*/

putRole(array $params = [])

/*
$params['name']    = (string) Role name
$params['refresh'] = (enum) 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. (Options = true,false,wait_for)
$params['body']    = (array) The role to add (Required)
*/

putRoleMapping(array $params = [])

/*
$params['name']    = (string) Role-mapping name
$params['refresh'] = (enum) 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. (Options = true,false,wait_for)
$params['body']    = (array) The role mapping to add (Required)
*/

putUser(array $params = [])

/*
$params['username'] = (string) The username of the User
$params['refresh']  = (enum) 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. (Options = true,false,wait_for)
$params['body']     = (array) The user to add (Required)
*/
« Elasticsearch\Namespaces\SearchableSnapshotsNamespace Elasticsearch\Namespaces\SlmNamespace »