Lines Matching defs:params
34 * @param array $params Associative array of parameters
38 public function authenticate(array $params = [])
43 $endpoint->setParams($params);
50 * $params['username'] = (string) The username of the user to change the password for
51 * $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)
52 * $params['body'] = (array) the new password for the user (Required)
54 * @param array $params Associative array of parameters
58 public function changePassword(array $params = [])
60 $username = $this->extractArgument($params, 'username');
61 $body = $this->extractArgument($params, 'body');
65 $endpoint->setParams($params);
74 * $params['ids'] = (list) A comma-separated list of IDs of API keys to clear from the cache
76 * @param array $params Associative array of parameters
80 public function clearApiKeyCache(array $params = [])
82 $ids = $this->extractArgument($params, 'ids');
86 $endpoint->setParams($params);
94 * $params['application'] = (list) A comma-separated list of application names
96 * @param array $params Associative array of parameters
100 public function clearCachedPrivileges(array $params = [])
102 $application = $this->extractArgument($params, 'application');
106 $endpoint->setParams($params);
114 * $params['realms'] = (list) Comma-separated list of realms to clear
115 * $params['usernames'] = (list) Comma-separated list of usernames to clear from the cache
117 * @param array $params Associative array of parameters
121 public function clearCachedRealms(array $params = [])
123 $realms = $this->extractArgument($params, 'realms');
127 $endpoint->setParams($params);
135 * $params['name'] = (list) Role name
137 * @param array $params Associative array of parameters
141 public function clearCachedRoles(array $params = [])
143 $name = $this->extractArgument($params, 'name');
147 $endpoint->setParams($params);
155 * $params['namespace'] = (string) An identifier for the namespace
156 * $params['service'] = (string) An identifier for the service name
157 * $params['name'] = (list) A comma-separated list of service token names
159 * @param array $params Associative array of parameters
166 public function clearCachedServiceTokens(array $params = [])
168 $namespace = $this->extractArgument($params, 'namespace');
169 $service = $this->extractArgument($params, 'service');
170 $name = $this->extractArgument($params, 'name');
174 $endpoint->setParams($params);
184 * $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)
185 * $params['body'] = (array) The api key request to create an API key (Required)
187 * @param array $params Associative array of parameters
191 public function createApiKey(array $params = [])
193 $body = $this->extractArgument($params, 'body');
197 $endpoint->setParams($params);
205 * $params['namespace'] = (string) An identifier for the namespace (Required)
206 * $params['service'] = (string) An identifier for the service name (Required)
207 * $params['name'] = (string) An identifier for the token name
208 * $params['refresh'] = (enum) If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (Options = true,false,wait_for)
210 * @param array $params Associative array of parameters
217 public function createServiceToken(array $params = [])
219 $namespace = $this->extractArgument($params, 'namespace');
220 $service = $this->extractArgument($params, 'service');
221 $name = $this->extractArgument($params, 'name');
225 $endpoint->setParams($params);
235 * $params['application'] = (string) Application name
236 * $params['name'] = (string) Privilege name
237 * $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)
239 * @param array $params Associative array of parameters
243 public function deletePrivileges(array $params = [])
245 $application = $this->extractArgument($params, 'application');
246 $name = $this->extractArgument($params, 'name');
250 $endpoint->setParams($params);
259 * $params['name'] = (string) Role name
260 * $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)
262 * @param array $params Associative array of parameters
266 public function deleteRole(array $params = [])
268 $name = $this->extractArgument($params, 'name');
272 $endpoint->setParams($params);
280 * $params['name'] = (string) Role-mapping name
281 * $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)
283 * @param array $params Associative array of parameters
287 public function deleteRoleMapping(array $params = [])
289 $name = $this->extractArgument($params, 'name');
293 $endpoint->setParams($params);
301 * $params['namespace'] = (string) An identifier for the namespace
302 * $params['service'] = (string) An identifier for the service name
303 * $params['name'] = (string) An identifier for the token name
304 * $params['refresh'] = (enum) If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (Options = true,false,wait_for)
306 * @param array $params Associative array of parameters
313 public function deleteServiceToken(array $params = [])
315 $namespace = $this->extractArgument($params, 'namespace');
316 $service = $this->extractArgument($params, 'service');
317 $name = $this->extractArgument($params, 'name');
321 $endpoint->setParams($params);
331 * $params['username'] = (string) username
332 * $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)
334 * @param array $params Associative array of parameters
338 public function deleteUser(array $params = [])
340 $username = $this->extractArgument($params, 'username');
344 $endpoint->setParams($params);
352 * $params['username'] = (string) The username of the user to disable
353 * $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)
355 * @param array $params Associative array of parameters
359 public function disableUser(array $params = [])
361 $username = $this->extractArgument($params, 'username');
365 $endpoint->setParams($params);
373 * $params['username'] = (string) The username of the user to enable
374 * $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)
376 * @param array $params Associative array of parameters
380 public function enableUser(array $params = [])
382 $username = $this->extractArgument($params, 'username');
386 $endpoint->setParams($params);
394 * $params['id'] = (string) API key id of the API key to be retrieved
395 * $params['name'] = (string) API key name of the API key to be retrieved
396 * $params['username'] = (string) user name of the user who created this API key to be retrieved
397 * $params['realm_name'] = (string) realm name of the user who created this API key to be retrieved
398 * $params['owner'] = (boolean) flag to query API keys owned by the currently authenticated user (Default = false)
400 * @param array $params Associative array of parameters
404 public function getApiKey(array $params = [])
409 $endpoint->setParams($params);
417 * @param array $params Associative array of parameters
421 public function getBuiltinPrivileges(array $params = [])
426 $endpoint->setParams($params);
433 * $params['application'] = (string) Application name
434 * $params['name'] = (string) Privilege name
436 * @param array $params Associative array of parameters
440 public function getPrivileges(array $params = [])
442 $application = $this->extractArgument($params, 'application');
443 $name = $this->extractArgument($params, 'name');
447 $endpoint->setParams($params);
456 * $params['name'] = (list) A comma-separated list of role names
458 * @param array $params Associative array of parameters
462 public function getRole(array $params = [])
464 $name = $this->extractArgument($params, 'name');
468 $endpoint->setParams($params);
476 * $params['name'] = (list) A comma-separated list of role-mapping names
478 * @param array $params Associative array of parameters
482 public function getRoleMapping(array $params = [])
484 $name = $this->extractArgument($params, 'name');
488 $endpoint->setParams($params);
496 * $params['namespace'] = (string) An identifier for the namespace
497 * $params['service'] = (string) An identifier for the service name
499 * @param array $params Associative array of parameters
506 public function getServiceAccounts(array $params = [])
508 $namespace = $this->extractArgument($params, 'namespace');
509 $service = $this->extractArgument($params, 'service');
513 $endpoint->setParams($params);
522 * $params['namespace'] = (string) An identifier for the namespace
523 * $params['service'] = (string) An identifier for the service name
525 * @param array $params Associative array of parameters
532 public function getServiceCredentials(array $params = [])
534 $namespace = $this->extractArgument($params, 'namespace');
535 $service = $this->extractArgument($params, 'service');
539 $endpoint->setParams($params);
548 * $params['body'] = (array) The token request to get (Required)
550 * @param array $params Associative array of parameters
554 public function getToken(array $params = [])
556 $body = $this->extractArgument($params, 'body');
560 $endpoint->setParams($params);
568 * $params['username'] = (list) A comma-separated list of usernames
570 * @param array $params Associative array of parameters
574 public function getUser(array $params = [])
576 $username = $this->extractArgument($params, 'username');
580 $endpoint->setParams($params);
589 * @param array $params Associative array of parameters
593 public function getUserPrivileges(array $params = [])
598 $endpoint->setParams($params);
605 * $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)
606 * $params['body'] = (array) The api key request to create an API key (Required)
608 * @param array $params Associative array of parameters
612 public function grantApiKey(array $params = [])
614 $body = $this->extractArgument($params, 'body');
618 $endpoint->setParams($params);
626 * $params['user'] = (string) Username
627 * $params['body'] = (array) The privileges to test (Required)
629 * @param array $params Associative array of parameters
633 public function hasPrivileges(array $params = [])
635 $user = $this->extractArgument($params, 'user');
636 $body = $this->extractArgument($params, 'body');
640 $endpoint->setParams($params);
649 * $params['body'] = (array) The api key request to invalidate API key(s) (Required)
651 * @param array $params Associative array of parameters
655 public function invalidateApiKey(array $params = [])
657 $body = $this->extractArgument($params, 'body');
661 $endpoint->setParams($params);
669 * $params['body'] = (array) The token to invalidate (Required)
671 * @param array $params Associative array of parameters
675 public function invalidateToken(array $params = [])
677 $body = $this->extractArgument($params, 'body');
681 $endpoint->setParams($params);
689 * $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)
690 * $params['body'] = (array) The privilege(s) to add (Required)
692 * @param array $params Associative array of parameters
696 public function putPrivileges(array $params = [])
698 $body = $this->extractArgument($params, 'body');
702 $endpoint->setParams($params);
710 * $params['name'] = (string) Role name
711 * $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)
712 * $params['body'] = (array) The role to add (Required)
714 * @param array $params Associative array of parameters
718 public function putRole(array $params = [])
720 $name = $this->extractArgument($params, 'name');
721 $body = $this->extractArgument($params, 'body');
725 $endpoint->setParams($params);
734 * $params['name'] = (string) Role-mapping name
735 * $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)
736 * $params['body'] = (array) The role mapping to add (Required)
738 * @param array $params Associative array of parameters
742 public function putRoleMapping(array $params = [])
744 $name = $this->extractArgument($params, 'name');
745 $body = $this->extractArgument($params, 'body');
749 $endpoint->setParams($params);
758 * $params['username'] = (string) The username of the User
759 * $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)
760 * $params['body'] = (array) The user to add (Required)
762 * @param array $params Associative array of parameters
766 public function putUser(array $params = [])
768 $username = $this->extractArgument($params, 'username');
769 $body = $this->extractArgument($params, 'body');
773 $endpoint->setParams($params);
782 * $params['body'] = (array) From, size, query, sort and search_after
784 * @param array $params Associative array of parameters
788 public function queryApiKeys(array $params = [])
790 $body = $this->extractArgument($params, 'body');
794 $endpoint->setParams($params);
802 * $params['body'] = (array) The SAML response to authenticate (Required)
804 * @param array $params Associative array of parameters
808 public function samlAuthenticate(array $params = [])
810 $body = $this->extractArgument($params, 'body');
814 $endpoint->setParams($params);
822 * $params['body'] = (array) The logout response to verify (Required)
824 * @param array $params Associative array of parameters
828 public function samlCompleteLogout(array $params = [])
830 $body = $this->extractArgument($params, 'body');
834 $endpoint->setParams($params);
842 * $params['body'] = (array) The LogoutRequest message (Required)
844 * @param array $params Associative array of parameters
848 public function samlInvalidate(array $params = [])
850 $body = $this->extractArgument($params, 'body');
854 $endpoint->setParams($params);
862 * $params['body'] = (array) The tokens to invalidate (Required)
864 * @param array $params Associative array of parameters
868 public function samlLogout(array $params = [])
870 $body = $this->extractArgument($params, 'body');
874 $endpoint->setParams($params);
882 * $params['body'] = (array) The realm for which to create the authentication request, identified by either its name or the ACS URL (Required)
884 * @param array $params Associative array of parameters
888 public function samlPrepareAuthentication(array $params = [])
890 $body = $this->extractArgument($params, 'body');
894 $endpoint->setParams($params);
902 * $params['realm_name'] = (string) The name of the SAML realm to get the metadata for
904 * @param array $params Associative array of parameters
908 public function samlServiceProviderMetadata(array $params = [])
910 $realm_name = $this->extractArgument($params, 'realm_name');
914 $endpoint->setParams($params);