1 2 3[[Elasticsearch_Namespaces_SecurityNamespace]] 4=== Elasticsearch\Namespaces\SecurityNamespace 5 6 7 8Class SecurityNamespace 9 10*Description* 11 12 13NOTE: this file is autogenerated using util/GenerateEndpoints.php 14and Elasticsearch 7.12.1 (3186837139b9c6b6d23c3200870651f10d3343b7) 15 16 17*Methods* 18 19The class defines the following methods: 20 21* <<Elasticsearch_Namespaces_SecurityNamespaceauthenticate_authenticate,`authenticate()`>> 22* <<Elasticsearch_Namespaces_SecurityNamespacechangePassword_changePassword,`changePassword()`>> 23* <<Elasticsearch_Namespaces_SecurityNamespaceclearApiKeyCache_clearApiKeyCache,`clearApiKeyCache()`>> 24* <<Elasticsearch_Namespaces_SecurityNamespaceclearCachedPrivileges_clearCachedPrivileges,`clearCachedPrivileges()`>> 25* <<Elasticsearch_Namespaces_SecurityNamespaceclearCachedRealms_clearCachedRealms,`clearCachedRealms()`>> 26* <<Elasticsearch_Namespaces_SecurityNamespaceclearCachedRoles_clearCachedRoles,`clearCachedRoles()`>> 27* <<Elasticsearch_Namespaces_SecurityNamespacecreateApiKey_createApiKey,`createApiKey()`>> 28* <<Elasticsearch_Namespaces_SecurityNamespacedeletePrivileges_deletePrivileges,`deletePrivileges()`>> 29* <<Elasticsearch_Namespaces_SecurityNamespacedeleteRole_deleteRole,`deleteRole()`>> 30* <<Elasticsearch_Namespaces_SecurityNamespacedeleteRoleMapping_deleteRoleMapping,`deleteRoleMapping()`>> 31* <<Elasticsearch_Namespaces_SecurityNamespacedeleteUser_deleteUser,`deleteUser()`>> 32* <<Elasticsearch_Namespaces_SecurityNamespacedisableUser_disableUser,`disableUser()`>> 33* <<Elasticsearch_Namespaces_SecurityNamespaceenableUser_enableUser,`enableUser()`>> 34* <<Elasticsearch_Namespaces_SecurityNamespacegetApiKey_getApiKey,`getApiKey()`>> 35* <<Elasticsearch_Namespaces_SecurityNamespacegetBuiltinPrivileges_getBuiltinPrivileges,`getBuiltinPrivileges()`>> 36* <<Elasticsearch_Namespaces_SecurityNamespacegetPrivileges_getPrivileges,`getPrivileges()`>> 37* <<Elasticsearch_Namespaces_SecurityNamespacegetRole_getRole,`getRole()`>> 38* <<Elasticsearch_Namespaces_SecurityNamespacegetRoleMapping_getRoleMapping,`getRoleMapping()`>> 39* <<Elasticsearch_Namespaces_SecurityNamespacegetToken_getToken,`getToken()`>> 40* <<Elasticsearch_Namespaces_SecurityNamespacegetUser_getUser,`getUser()`>> 41* <<Elasticsearch_Namespaces_SecurityNamespacegetUserPrivileges_getUserPrivileges,`getUserPrivileges()`>> 42* <<Elasticsearch_Namespaces_SecurityNamespacegrantApiKey_grantApiKey,`grantApiKey()`>> 43* <<Elasticsearch_Namespaces_SecurityNamespacehasPrivileges_hasPrivileges,`hasPrivileges()`>> 44* <<Elasticsearch_Namespaces_SecurityNamespaceinvalidateApiKey_invalidateApiKey,`invalidateApiKey()`>> 45* <<Elasticsearch_Namespaces_SecurityNamespaceinvalidateToken_invalidateToken,`invalidateToken()`>> 46* <<Elasticsearch_Namespaces_SecurityNamespaceputPrivileges_putPrivileges,`putPrivileges()`>> 47* <<Elasticsearch_Namespaces_SecurityNamespaceputRole_putRole,`putRole()`>> 48* <<Elasticsearch_Namespaces_SecurityNamespaceputRoleMapping_putRoleMapping,`putRoleMapping()`>> 49* <<Elasticsearch_Namespaces_SecurityNamespaceputUser_putUser,`putUser()`>> 50 51 52 53[[Elasticsearch_Namespaces_SecurityNamespaceauthenticate_authenticate]] 54.`authenticate(array $params = [])` 55**** 56[source,php] 57---- 58/* 59*/ 60---- 61**** 62 63 64 65[[Elasticsearch_Namespaces_SecurityNamespacechangePassword_changePassword]] 66.`changePassword(array $params = [])` 67**** 68[source,php] 69---- 70/* 71$params['username'] = (string) The username of the user to change the password for 72$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) 73$params['body'] = (array) the new password for the user (Required) 74*/ 75---- 76**** 77 78 79 80[[Elasticsearch_Namespaces_SecurityNamespaceclearApiKeyCache_clearApiKeyCache]] 81.`clearApiKeyCache(array $params = [])` 82**** 83[source,php] 84---- 85/* 86$params['ids'] = (list) A comma-separated list of IDs of API keys to clear from the cache 87*/ 88---- 89**** 90 91 92 93[[Elasticsearch_Namespaces_SecurityNamespaceclearCachedPrivileges_clearCachedPrivileges]] 94.`clearCachedPrivileges(array $params = [])` 95**** 96[source,php] 97---- 98/* 99$params['application'] = (list) A comma-separated list of application names 100*/ 101---- 102**** 103 104 105 106[[Elasticsearch_Namespaces_SecurityNamespaceclearCachedRealms_clearCachedRealms]] 107.`clearCachedRealms(array $params = [])` 108**** 109[source,php] 110---- 111/* 112$params['realms'] = (list) Comma-separated list of realms to clear 113$params['usernames'] = (list) Comma-separated list of usernames to clear from the cache 114*/ 115---- 116**** 117 118 119 120[[Elasticsearch_Namespaces_SecurityNamespaceclearCachedRoles_clearCachedRoles]] 121.`clearCachedRoles(array $params = [])` 122**** 123[source,php] 124---- 125/* 126$params['name'] = (list) Role name 127*/ 128---- 129**** 130 131 132 133[[Elasticsearch_Namespaces_SecurityNamespacecreateApiKey_createApiKey]] 134.`createApiKey(array $params = [])` 135**** 136[source,php] 137---- 138/* 139$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) 140$params['body'] = (array) The api key request to create an API key (Required) 141*/ 142---- 143**** 144 145 146 147[[Elasticsearch_Namespaces_SecurityNamespacedeletePrivileges_deletePrivileges]] 148.`deletePrivileges(array $params = [])` 149**** 150[source,php] 151---- 152/* 153$params['application'] = (string) Application name 154$params['name'] = (string) Privilege name 155$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) 156*/ 157---- 158**** 159 160 161 162[[Elasticsearch_Namespaces_SecurityNamespacedeleteRole_deleteRole]] 163.`deleteRole(array $params = [])` 164**** 165[source,php] 166---- 167/* 168$params['name'] = (string) Role name 169$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) 170*/ 171---- 172**** 173 174 175 176[[Elasticsearch_Namespaces_SecurityNamespacedeleteRoleMapping_deleteRoleMapping]] 177.`deleteRoleMapping(array $params = [])` 178**** 179[source,php] 180---- 181/* 182$params['name'] = (string) Role-mapping name 183$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) 184*/ 185---- 186**** 187 188 189 190[[Elasticsearch_Namespaces_SecurityNamespacedeleteUser_deleteUser]] 191.`deleteUser(array $params = [])` 192**** 193[source,php] 194---- 195/* 196$params['username'] = (string) username 197$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) 198*/ 199---- 200**** 201 202 203 204[[Elasticsearch_Namespaces_SecurityNamespacedisableUser_disableUser]] 205.`disableUser(array $params = [])` 206**** 207[source,php] 208---- 209/* 210$params['username'] = (string) The username of the user to disable 211$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) 212*/ 213---- 214**** 215 216 217 218[[Elasticsearch_Namespaces_SecurityNamespaceenableUser_enableUser]] 219.`enableUser(array $params = [])` 220**** 221[source,php] 222---- 223/* 224$params['username'] = (string) The username of the user to enable 225$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) 226*/ 227---- 228**** 229 230 231 232[[Elasticsearch_Namespaces_SecurityNamespacegetApiKey_getApiKey]] 233.`getApiKey(array $params = [])` 234**** 235[source,php] 236---- 237/* 238$params['id'] = (string) API key id of the API key to be retrieved 239$params['name'] = (string) API key name of the API key to be retrieved 240$params['username'] = (string) user name of the user who created this API key to be retrieved 241$params['realm_name'] = (string) realm name of the user who created this API key to be retrieved 242$params['owner'] = (boolean) flag to query API keys owned by the currently authenticated user (Default = false) 243*/ 244---- 245**** 246 247 248 249[[Elasticsearch_Namespaces_SecurityNamespacegetBuiltinPrivileges_getBuiltinPrivileges]] 250.`getBuiltinPrivileges(array $params = [])` 251**** 252[source,php] 253---- 254/* 255*/ 256---- 257**** 258 259 260 261[[Elasticsearch_Namespaces_SecurityNamespacegetPrivileges_getPrivileges]] 262.`getPrivileges(array $params = [])` 263**** 264[source,php] 265---- 266/* 267$params['application'] = (string) Application name 268$params['name'] = (string) Privilege name 269*/ 270---- 271**** 272 273 274 275[[Elasticsearch_Namespaces_SecurityNamespacegetRole_getRole]] 276.`getRole(array $params = [])` 277**** 278[source,php] 279---- 280/* 281$params['name'] = (list) A comma-separated list of role names 282*/ 283---- 284**** 285 286 287 288[[Elasticsearch_Namespaces_SecurityNamespacegetRoleMapping_getRoleMapping]] 289.`getRoleMapping(array $params = [])` 290**** 291[source,php] 292---- 293/* 294$params['name'] = (list) A comma-separated list of role-mapping names 295*/ 296---- 297**** 298 299 300 301[[Elasticsearch_Namespaces_SecurityNamespacegetToken_getToken]] 302.`getToken(array $params = [])` 303**** 304[source,php] 305---- 306/* 307$params['body'] = (array) The token request to get (Required) 308*/ 309---- 310**** 311 312 313 314[[Elasticsearch_Namespaces_SecurityNamespacegetUser_getUser]] 315.`getUser(array $params = [])` 316**** 317[source,php] 318---- 319/* 320$params['username'] = (list) A comma-separated list of usernames 321*/ 322---- 323**** 324 325 326 327[[Elasticsearch_Namespaces_SecurityNamespacegetUserPrivileges_getUserPrivileges]] 328.`getUserPrivileges(array $params = [])` 329**** 330[source,php] 331---- 332/* 333*/ 334---- 335**** 336 337 338 339[[Elasticsearch_Namespaces_SecurityNamespacegrantApiKey_grantApiKey]] 340.`grantApiKey(array $params = [])` 341**** 342[source,php] 343---- 344/* 345$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) 346$params['body'] = (array) The api key request to create an API key (Required) 347*/ 348---- 349**** 350 351 352 353[[Elasticsearch_Namespaces_SecurityNamespacehasPrivileges_hasPrivileges]] 354.`hasPrivileges(array $params = [])` 355**** 356[source,php] 357---- 358/* 359$params['user'] = (string) Username 360$params['body'] = (array) The privileges to test (Required) 361*/ 362---- 363**** 364 365 366 367[[Elasticsearch_Namespaces_SecurityNamespaceinvalidateApiKey_invalidateApiKey]] 368.`invalidateApiKey(array $params = [])` 369**** 370[source,php] 371---- 372/* 373*/ 374---- 375**** 376 377 378 379[[Elasticsearch_Namespaces_SecurityNamespaceinvalidateToken_invalidateToken]] 380.`invalidateToken(array $params = [])` 381**** 382[source,php] 383---- 384/* 385$params['body'] = (array) The token to invalidate (Required) 386*/ 387---- 388**** 389 390 391 392[[Elasticsearch_Namespaces_SecurityNamespaceputPrivileges_putPrivileges]] 393.`putPrivileges(array $params = [])` 394**** 395[source,php] 396---- 397/* 398$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) 399$params['body'] = (array) The privilege(s) to add (Required) 400*/ 401---- 402**** 403 404 405 406[[Elasticsearch_Namespaces_SecurityNamespaceputRole_putRole]] 407.`putRole(array $params = [])` 408**** 409[source,php] 410---- 411/* 412$params['name'] = (string) Role name 413$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) 414$params['body'] = (array) The role to add (Required) 415*/ 416---- 417**** 418 419 420 421[[Elasticsearch_Namespaces_SecurityNamespaceputRoleMapping_putRoleMapping]] 422.`putRoleMapping(array $params = [])` 423**** 424[source,php] 425---- 426/* 427$params['name'] = (string) Role-mapping name 428$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) 429$params['body'] = (array) The role mapping to add (Required) 430*/ 431---- 432**** 433 434 435 436[[Elasticsearch_Namespaces_SecurityNamespaceputUser_putUser]] 437.`putUser(array $params = [])` 438**** 439[source,php] 440---- 441/* 442$params['username'] = (string) The username of the User 443$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) 444$params['body'] = (array) The user to add (Required) 445*/ 446---- 447**** 448 449 450