extends |
AbstractNamespace |
|---|
Class SecurityNamespace
NOTE: This file is autogenerated using util/GenerateEndpoints.php
| Methods | ||||
|---|---|---|---|---|
public
|
authinfo(array $params = []): array
Returns or updates authentication information for the currently authenticated user.
Returns or updates authentication information for the currently authenticated user. $params['auth_type'] = (string) The type of the current authentication request. $params['verbose'] = (boolean) Whether to return a verbose response. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
authtoken(array $params = []): array
Returns the authorization token for the current user.
Returns the authorization token for the current user. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
cache(array $params = []): array
Not supported for the Cache API.
Not supported for the Cache API. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
configUpgradeCheck(array $params = []): array
Checks whether or not an upgrade can be performed and which security resources can be updated.
Checks whether or not an upgrade can be performed and which security resources can be updated. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
configUpgradePerform(array $params = []): array
Assists the cluster operator with upgrading missing default values and stale default definitions.
Assists the cluster operator with upgrading missing default values and stale default definitions. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
createAllowlist(array $params = []): array
Creates or replaces APIs permitted for users on the allow list. Requires a super admin certificate or REST API…
Creates or replaces APIs permitted for users on the allow list. Requires a super admin certificate or REST API permissions. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
createUpdateTenancyConfig(array $params = []): array
Creates or replaces the multi-tenancy configuration. Requires super admin or REST API permissions.
Creates or replaces the multi-tenancy configuration. Requires super admin or REST API permissions. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
createUserLegacy(array $params = []): array
Creates or replaces the specified user. Legacy API.
Creates or replaces the specified user. Legacy API. $params['username'] = (string) The name of the user to create. (Required) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
deleteActionGroup(array $params = []): array
Deletes the specified action group.
Deletes the specified action group. $params['action_group'] = (string) The name of the action group to delete. (Required) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
deleteDistinguishedName(array $params = []): array
Deletes all distinguished names in the specified cluster or node allowlist. Requires super admin or REST API…
Deletes all distinguished names in the specified cluster or node allowlist. Requires super admin or REST API permissions. $params['cluster_name'] = (string) The cluster name to delete from list of distinguished names. (Required) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
deleteRole(array $params = []): array
Deletes the specified role.
Deletes the specified role. $params['role'] = (string) The name of the role to delete. (Required) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
deleteRoleMapping(array $params = []): array
Deletes the specified role mapping.
Deletes the specified role mapping. $params['role'] = (string) The name of the role for which to delete the role's mappings. (Required) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
deleteTenant(array $params = []): array
Deletes the specified tenant.
Deletes the specified tenant. $params['tenant'] = (string) The name of the tenant to delete. (Required) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
deleteUser(array $params = []): array
Deletes the specified internal user.
Deletes the specified internal user. $params['username'] = (string) The name of the user to delete. (Required) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
deleteUserLegacy(array $params = []): array
Delete the specified user. Legacy API.
Delete the specified user. Legacy API. $params['username'] = (string) The name of the user to delete. (Required) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
flushCache(array $params = []): array
Flushes the Security plugin's user, authentication, and authorization cache.
Flushes the Security plugin's user, authentication, and authorization cache. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
generateOboToken(array $params = []): array
Generates a `On-Behalf-Of` token for the current user.
Generates a $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
generateUserToken(array $params = []): array
Generates an authorization token for the specified user.
Generates an authorization token for the specified user. $params['username'] = (string) The name of the user for whom to issue an authorization token. (Required) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
generateUserTokenLegacy(array $params = []): array
Generates authorization token for the given user. Legacy API. Not Implemented.
Generates authorization token for the given user. Legacy API. Not Implemented. $params['username'] = (string) The name of the user for whom to issue an authorization token. (Required) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
getAccountDetails(array $params = []): array
Returns account information for the current user.
Returns account information for the current user. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
getActionGroup(array $params = []): array
Retrieves one action group.
Retrieves one action group. $params['action_group'] = (string) The name of the action group to retrieve. (Required) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
getAllCertificates(array $params = []): array
Retrieves the cluster security certificates.
Retrieves the cluster security certificates. $params['cert_type'] = (string) The type of certificates ( Parameters
|
# | ||
public
|
getAllowlist(array $params = []): array
Retrieves the current list of allowed APIs accessible to a normal user.
Retrieves the current list of allowed APIs accessible to a normal user. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
getAuditConfiguration(array $params = []): array
Retrieves the audit configuration.
Retrieves the audit configuration. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
getCertificates(array $params = []): array
Retrieves the cluster security certificates.
Retrieves the cluster security certificates. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
getConfiguration(array $params = []): array
Returns the current Security plugin configuration in a JSON format.
Returns the current Security plugin configuration in a JSON format. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
getDashboardsInfo(array $params = []): array
Retrieves the current values for dynamic security settings for OpenSearch Dashboards.
Retrieves the current values for dynamic security settings for OpenSearch Dashboards. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
getDistinguishedName(array $params = []): array
Retrieves all node distinguished names. Requires super admin or REST API permissions.
Retrieves all node distinguished names. Requires super admin or REST API permissions. $params['cluster_name'] = (string) The name of the cluster to retrieve that cluster's nodes DN settings. (Required) $params['show_all'] = (boolean) Whether to include or exclude any static node's DN settings from the final result. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
getNodeCertificates(array $params = []): array
Retrieves the specified node's security certificates.
Retrieves the specified node's security certificates. $params['node_id'] = (string) The node ID to retrieve certificates for.
$params['cert_type'] = (string) The type of certificates ( Parameters
|
# | ||
public
|
getPermissionsInfo(array $params = []): array
Retrieves the evaluated REST API permissions for the currently logged in user.
Retrieves the evaluated REST API permissions for the currently logged in user. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
getRole(array $params = []): array
Retrieves one role.
Retrieves one role. $params['role'] = (string) The name of the role to retrieve. (Required) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
getRoleMapping(array $params = []): array
Retrieves the specified role mapping.
Retrieves the specified role mapping. $params['role'] = (string) The name of the role mapping to retrieve. (Required) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
getSslinfo(array $params = []): array
Retrieves information about the SSL configuration.
Retrieves information about the SSL configuration. $params['show_dn'] = (Array) Whether to include all domain names in the response. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
getTenancyConfig(array $params = []): array
Retrieves the multi-tenancy configuration. Requires super admin or REST API permissions.
Retrieves the multi-tenancy configuration. Requires super admin or REST API permissions. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
getTenant(array $params = []): array
Retrieves the specified tenant.
Retrieves the specified tenant. $params['tenant'] = (string) The name of the tenant to retrieve. (Required) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
getUser(array $params = []): array
Retrieve information about the specified internal user.
Retrieve information about the specified internal user. $params['username'] = (string) The name of the user to retrieve. (Required) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
getUserLegacy(array $params = []): array
Retrieve one user. Legacy API.
Retrieve one user. Legacy API. $params['username'] = (string) The name of the user to retrieve. (Required) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
getUsersLegacy(array $params = []): array
Retrieve all internal users. Legacy API.
Retrieve all internal users. Legacy API. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
health(array $params = []): array
Checks to see if the Security plugin is running.
Checks to see if the Security plugin is running. $params['mode'] = (string) A flag that determines whether to consider the security status before returning a response for a health query response. For example, Parameters
|
# | ||
public
|
migrate(array $params = []): array
Migrates the security configuration from v6 to v7.
Migrates the security configuration from v6 to v7. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
patchActionGroup(array $params = []): array
Updates the individual attributes of an action group.
Updates the individual attributes of an action group. $params['action_group'] = (string) The name of the action group to update. (Required) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
patchAllowlist(array $params = []): array
Updates the current list of APIs accessible for users on the allow list.
Updates the current list of APIs accessible for users on the allow list. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
patchAuditConfiguration(array $params = []): array
Updates the specified fields in the audit configuration.
Updates the specified fields in the audit configuration. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
patchConfiguration(array $params = []): array
Updates the existing security configuration using the REST API. Requires super admin or REST API permissions.
Updates the existing security configuration using the REST API. Requires super admin or REST API permissions. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
patchDistinguishedName(array $params = []): array
Updates the distinguished cluster name for the specified cluster. Requires super admin or REST API permissions.
Updates the distinguished cluster name for the specified cluster. Requires super admin or REST API permissions. $params['cluster_name'] = (string) The cluster name to update the Parameters
|
# | ||
public
|
patchDistinguishedNames(array $params = []): array
Bulk updates specified node distinguished names. Requires super admin or REST API permissions.
Bulk updates specified node distinguished names. Requires super admin or REST API permissions. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
patchRole(array $params = []): array
Updates the individual attributes of a role.
Updates the individual attributes of a role. $params['role'] = (string) The name of the role to update. (Required) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
patchRoleMapping(array $params = []): array
Updates the individual attributes of a role mapping.
Updates the individual attributes of a role mapping. $params['role'] = (string) The name of the role to update a role mapping for (Required) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
patchTenant(array $params = []): array
Adds, deletes, or modifies a single tenant.
Adds, deletes, or modifies a single tenant. $params['tenant'] = (string) The name of the tenant to update. (Required) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
patchUser(array $params = []): array
Updates individual attributes for an internal user.
Updates individual attributes for an internal user. $params['username'] = (string) The name of the user to update. (Required) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
postDashboardsInfo(array $params = []): array
Retrieves the current values for dynamic security settings for OpenSearch Dashboards.
Retrieves the current values for dynamic security settings for OpenSearch Dashboards. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
reloadHttpCertificates(array $params = []): array
Reloads the HTTP communication certificates.
Reloads the HTTP communication certificates. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
reloadTransportCertificates(array $params = []): array
Reloads the transport communication certificates.
Reloads the transport communication certificates. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
tenantInfo(array $params = []): array
Retrieves the names of current tenants. Requires super admin or `kibanaserver` permissions.
Retrieves the names of current tenants. Requires super admin or $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
updateAuditConfiguration(array $params = []): array
Updates the audit configuration.
Updates the audit configuration. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
updateConfiguration(array $params = []): array
Updates the settings for an existing security configuration. Requires super admin or REST API permissions.
Updates the settings for an existing security configuration. Requires super admin or REST API permissions. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
updateDistinguishedName(array $params = []): array
Adds or updates the specified distinguished names in the cluster or node allowlist. Requires super admin or REST API…
Adds or updates the specified distinguished names in the cluster or node allowlist. Requires super admin or REST API permissions. $params['cluster_name'] = (string) The name of the cluster containing the Parameters
|
# | ||
public
|
validate(array $params = []): array
Checks whether the v6 security configuration is valid and ready to be migrated to v7.
Checks whether the v6 security configuration is valid and ready to be migrated to v7. $params['accept_invalid'] = (boolean) Whether an invalid v6 configuration should be allowed. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
whoAmI(array $params = []): array
Gets the identity information for the user currently logged in.
Gets the identity information for the user currently logged in. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
whoAmIProtected(array $params = []): array
Gets the identity information for the user currently logged in. To use this operation, you must have access to this…
Gets the identity information for the user currently logged in. To use this operation, you must have access to this endpoint when authorization at REST layer is enabled. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
changePassword(array $params = []): array
Changes the password for the current user.
Changes the password for the current user. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. $params['human'] = (boolean) Whether to return human readable values for statistics. $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Comma-separated list of filters used to reduce the response. $params['current_password'] = (string) The current password $params['password'] = (string) New password Parameters
|
# | ||
public
|
createActionGroup(array $params = []): array
Creates or replaces the specified action group.
Creates or replaces the specified action group. $params['action_group'] = (string) The name of the action group to create or replace. (Required) $params['allowed_actions'] = (array) list of allowed actions $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. $params['human'] = (boolean) Whether to return human readable values for statistics. $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Comma-separated list of filters used to reduce the response. Parameters
|
# | ||
public
|
createRoleMapping(array $params = []): array
Creates or replaces the specified role mapping.
Creates or replaces the specified role mapping. $params['role'] = (string) (Required) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. $params['human'] = (boolean) Whether to return human readable values for statistics. $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Comma-separated list of filters used to reduce the response. $params['backend_roles'] = (array) $params['hosts'] = (array) $params['users'] = (array) Parameters
|
# | ||
public
|
createRole(array $params = []): array
Creates or replaces the specified role.
Creates or replaces the specified role. $params['role'] = (string) (Required) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. $params['human'] = (boolean) Whether to return human readable values for statistics. $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Comma-separated list of filters used to reduce the response. $params['cluster_permissions'] = (array) $params['index_permissions'] = (array) $params['tenant_permissions'] = (array) Parameters
|
# | ||
public
|
createTenant(array $params = []): array
Creates or replaces the specified tenant.
Creates or replaces the specified tenant. $params['tenant'] = (string) The name of the tenant to create $params['description'] = (string) Description of the tenant $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. $params['human'] = (boolean) Whether to return human readable values for statistics. $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Comma-separated list of filters used to reduce the response. Parameters
|
# | ||
public
|
createUser(array $params = []): array
Creates or replaces the specified user.
Creates or replaces the specified user. $params['username'] = (string) (Required) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. $params['human'] = (boolean) Whether to return human readable values for statistics. $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Comma-separated list of filters used to reduce the response. $params['password'] = (string) $params['opendistro_security_roles'] = (array) $params['backend_roles'] = (array) $params['attributes'] = (array) Parameters
|
# | ||
public
|
deleteDistinguishedNames(array $params = [])
Proxy function to deleteDistinguishedNames() to prevent BC break.
This API will be removed in a future version. Use …
Proxy function to deleteDistinguishedNames() to prevent BC break. This API will be removed in a future version. Use 'deleteDistinguishedName' API instead. |
# | ||
public
|
getAccount(array $params = [])
Proxy function to getAccount() to prevent BC break.
This API will be removed in a future version. Use …
Proxy function to getAccount() to prevent BC break. This API will be removed in a future version. Use 'getAccountDetails' API instead. |
# | ||
public
|
getActionGroups(array $params = []): array
Retrieves all action groups.
If 'action_group' is provided in $params, calls 'getActionGroup'.
Retrieves all action groups. If 'action_group' is provided in $params, calls 'getActionGroup'. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. $params['human'] = (boolean) Whether to return human readable values for statistics. $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Comma-separated list of filters used to reduce the response. Parameters
|
# | ||
public
|
getConfig(array $params = [])
Proxy function to getConfig() to prevent BC break.
This API will be removed in a future version. Use 'getConfiguration'…
Proxy function to getConfig() to prevent BC break. This API will be removed in a future version. Use 'getConfiguration' API instead. |
# | ||
public
|
getDistinguishedNames(array $params = []): array
Retrieves distinguished names. Only accessible to super-admins and with rest-api permissions when enabled.
If 'cluster…
Retrieves distinguished names. Only accessible to super-admins and with rest-api permissions when enabled. If 'cluster_name' is provided in $params, calls GetDistinguishedName. $params['cluster_name'] = (string) Name of the cluster. $params['show_all'] = (boolean) Show all DN. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. $params['human'] = (boolean) Whether to return human readable values for statistics. $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Comma-separated list of filters used to reduce the response. Parameters
|
# | ||
public
|
getRoleMappings(array $params = []): array
Retrieves role mappings. Only accessible to super-admins and with rest-api permissions when enabled.
If 'role' is…
Retrieves role mappings. Only accessible to super-admins and with rest-api permissions when enabled. If 'role' is provided in $params, calls GetRoleMapping. $params['role'] = (string) Name of the role. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. $params['human'] = (boolean) Whether to return human readable values for statistics. $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Comma-separated list of filters used to reduce the response. Parameters
|
# | ||
public
|
getRoles(array $params = []): array
Retrieves roles. Only accessible to super-admins and with rest-api permissions when enabled.
If 'role' is provided in …
Retrieves roles. Only accessible to super-admins and with rest-api permissions when enabled. If 'role' is provided in $params, calls getRole. $params['role'] = (string) Name of the role. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. $params['human'] = (boolean) Whether to return human readable values for statistics. $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Comma-separated list of filters used to reduce the response. Parameters
|
# | ||
public
|
getTenants(array $params = []): array
Retrieves tenants. Only accessible to super-admins and with rest-api permissions when enabled.
If 'tenant' is provided…
Retrieves tenants. Only accessible to super-admins and with rest-api permissions when enabled. If 'tenant' is provided in $params, calls GetTenant. $params['tenant'] = (string) Name of the tenant. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. $params['human'] = (boolean) Whether to return human readable values for statistics. $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Comma-separated list of filters used to reduce the response. Parameters
|
# | ||
public
|
getUsers(array $params = []): array
Retrieve all internal users.
If 'username' is provided in $params, calls 'getUser'.
Retrieve all internal users. If 'username' is provided in $params, calls 'getUser'. $params['username'] = (string) The username of the user to fetch, omit to fetch all (optional). $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. $params['human'] = (boolean) Whether to return human readable values for statistics. $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Comma-separated list of filters used to reduce the response. Parameters
|
# | ||
public
|
patchActionGroups(array $params = []): array
Creates, updates, or deletes multiple action groups in a single call.
If 'action_group' is provided in $params, calls…
Creates, updates, or deletes multiple action groups in a single call. If 'action_group' is provided in $params, calls patchActionGroup. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. $params['human'] = (boolean) Whether to return human readable values for statistics. $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Comma-separated list of filters used to reduce the response. Parameters
|
# | ||
public
|
patchConfig(array $params = [])
Proxy function to patchConfig() to prevent BC break.
This API will be removed in a future version. Use …
Proxy function to patchConfig() to prevent BC break. This API will be removed in a future version. Use 'patchConfiguration' API instead. |
# | ||
public
|
patchRoleMappings(array $params = []): array
Creates or updates multiple role mappings in a single call.
If 'role' is provided in $params, calls patchRoleMappings.
Creates or updates multiple role mappings in a single call. If 'role' is provided in $params, calls patchRoleMappings. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. $params['human'] = (boolean) Whether to return human readable values for statistics. $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Comma-separated list of filters used to reduce the response. Parameters
|
# | ||
public
|
patchRoles(array $params = []): array
Creates, updates, or deletes multiple roles in a single call.
If 'role' is provided in $params, calls patchRole.
Creates, updates, or deletes multiple roles in a single call. If 'role' is provided in $params, calls patchRole. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. $params['human'] = (boolean) Whether to return human readable values for statistics. $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Comma-separated list of filters used to reduce the response. Parameters
|
# | ||
public
|
patchTenants(array $params = []): array
Add, delete, or modify multiple tenants in a single call.
If 'tenant' is provided in $params, calls 'patchTenant'.
Add, delete, or modify multiple tenants in a single call. If 'tenant' is provided in $params, calls 'patchTenant'. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. $params['human'] = (boolean) Whether to return human readable values for statistics. $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Comma-separated list of filters used to reduce the response. Parameters
|
# | ||
public
|
patchUsers(array $params = []): array
Creates, updates, or deletes multiple internal users in a single call.
If 'username' is provided in $params, calls…
Creates, updates, or deletes multiple internal users in a single call. If 'username' is provided in $params, calls patchUser. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. $params['human'] = (boolean) Whether to return human readable values for statistics. $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Comma-separated list of filters used to reduce the response. Parameters
|
# | ||
public
|
updateConfig(array $params = [])
Proxy function to updateConfig() to prevent BC break.
This API will be removed in a future version. Use …
Proxy function to updateConfig() to prevent BC break. This API will be removed in a future version. Use 'updateConfiguration' API instead. |
# | ||
public
|
updateDistinguishedNames(array $params = [])
Proxy function to updateDistinguishedNames() to prevent BC break.
This API will be removed in a future version. Use …
Proxy function to updateDistinguishedNames() to prevent BC break. This API will be removed in a future version. Use 'updateDistinguishedName' API instead. |
# | ||
| Methods inherited from OpenSearch\Namespaces\AbstractNamespace |
|---|
__construct(), extractArgument(), performRequest() |
| Properties inherited from OpenSearch\Namespaces\AbstractNamespace |
|---|
$transport, $httpTransport, $endpointFactory, $endpoints |