Security Client

class opensearchpy.client.security.SecurityClient(client)

Bases: NamespacedClient

Parameters:

client (Any) –

change_password(body, params=None, headers=None)

Changes the password for the current user.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• body (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

create_action_group(action_group, body, params=None, headers=None)

Creates or replaces the specified action group.

Parameters:

• action_group (Any) – The name of the action group to create or replace

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• action_group –

• body (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

create_role(role, body, params=None, headers=None)

Creates or replaces the specified role.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• role (Any) –

• body (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

create_role_mapping(role, body, params=None, headers=None)

Creates or replaces the specified role mapping.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• role (Any) –

• body (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

create_tenant(tenant, body, params=None, headers=None)

Creates or replaces the specified tenant.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• tenant (Any) –

• body (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

create_user(username, body, params=None, headers=None)

Creates or replaces the specified user.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• username (Any) –

• body (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

delete_action_group(action_group, params=None, headers=None)

Delete a specified action group.

Parameters:

• action_group (Any) – Action group to delete.

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• action_group –

• params (Any) –

• headers (Any) –

Return type:

Any

delete_distinguished_names(cluster_name, params=None, headers=None)

Deletes all distinguished names in the specified cluster’s or node’s allow list.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• cluster_name (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

delete_role(role, params=None, headers=None)

Delete the specified role.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• role (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

delete_role_mapping(role, params=None, headers=None)

Deletes the specified role mapping.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• role (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

delete_tenant(tenant, params=None, headers=None)

Delete the specified tenant.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• tenant (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

delete_user(username, params=None, headers=None)

Delete the specified user.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• username (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

flush_cache(params=None, headers=None)

Flushes the Security plugin user, authentication, and authorization cache.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• params (Any) –

• headers (Any) –

Return type:

Any

get_account_details(params=None, headers=None)

Returns account details for the current user.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• params (Any) –

• headers (Any) –

Return type:

Any

get_action_group(action_group, params=None, headers=None)

Retrieves one action group.

Parameters:

• action_group (Any) – Action group to retrieve.

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• action_group –

• params (Any) –

• headers (Any) –

Return type:

Any

get_action_groups(params=None, headers=None)

Retrieves all action groups.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• params (Any) –

• headers (Any) –

Return type:

Any

get_audit_configuration(params=None, headers=None)

Retrieves the audit configuration.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• params (Any) –

• headers (Any) –

Return type:

Any

get_certificates(params=None, headers=None)

Retrieves the cluster’s security certificates.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• params (Any) –

• headers (Any) –

Return type:

Any

get_configuration(params=None, headers=None)

Returns the current Security plugin configuration in JSON format.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• params (Any) –

• headers (Any) –

Return type:

Any

get_distinguished_names(cluster_name=None, params=None, headers=None)

Retrieves distinguished names.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• cluster_name (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

get_role(role, params=None, headers=None)

Retrieves one role.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• role (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

get_role_mapping(role, params=None, headers=None)

Retrieves one role mapping.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• role (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

get_role_mappings(params=None, headers=None)

Retrieves all role mappings.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• params (Any) –

• headers (Any) –

Return type:

Any

get_roles(params=None, headers=None)

Retrieves all roles.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• params (Any) –

• headers (Any) –

Return type:

Any

get_tenant(tenant, params=None, headers=None)

Retrieves one tenant.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• tenant (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

get_tenants(params=None, headers=None)

Retrieves all tenants.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• params (Any) –

• headers (Any) –

Return type:

Any

get_user(username, params=None, headers=None)

Retrieve one internal user.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• username (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

get_users(params=None, headers=None)

Retrieve all internal users.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• params (Any) –

• headers (Any) –

Return type:

Any

health(params=None, headers=None)

Checks to see if the Security plugin is up and running.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• params (Any) –

• headers (Any) –

Return type:

Any

health_check(params=None, headers=None)

Checks to see if the Security plugin is up and running.

Warning

This API will be removed in a future version. Use ‘health’ API instead.

Parameters:

• self (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

patch_action_group(action_group, body, params=None, headers=None)

Updates individual attributes of an action group.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• action_group (Any) –

• body (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

patch_action_groups(body, params=None, headers=None)

Creates, updates, or deletes multiple action groups in a single call.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• body (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

patch_audit_configuration(body, params=None, headers=None)

A PATCH call is used to update specified fields in the audit configuration.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• body (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

patch_configuration(body, params=None, headers=None)

A PATCH call is used to update the existing configuration using the REST API.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• body (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

patch_distinguished_names(body, params=None, headers=None)

Bulk update of distinguished names.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• body (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

patch_role(role, body, params=None, headers=None)

Updates individual attributes of a role.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• role (Any) –

• body (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

patch_role_mapping(role, body, params=None, headers=None)

Updates individual attributes of a role mapping.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• role (Any) –

• body (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

patch_role_mappings(body, params=None, headers=None)

Creates or updates multiple role mappings in a single call.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• body (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

patch_roles(body, params=None, headers=None)

Creates, updates, or deletes multiple roles in a single call.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• body (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

patch_tenant(tenant, body, params=None, headers=None)

Add, delete, or modify a single tenant.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• tenant (Any) –

• body (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

patch_tenants(body, params=None, headers=None)

Add, delete, or modify multiple tenants in a single call.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• body (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

patch_user(username, body, params=None, headers=None)

Updates individual attributes of an internal user.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• username (Any) –

• body (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

patch_users(body, params=None, headers=None)

Creates, updates, or deletes multiple internal users in a single call.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• body (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

reload_http_certificates(params=None, headers=None)

Reload HTTP layer communication certificates.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• params (Any) –

• headers (Any) –

Return type:

Any

reload_transport_certificates(params=None, headers=None)

Reload transport layer communication certificates.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• params (Any) –

• headers (Any) –

Return type:

Any

update_audit_config(body, params=None, headers=None)

A PUT call updates the audit configuration.

Warning

This API will be removed in a future version. Use ‘update_audit_configuration’ API instead.

Parameters:

• self (Any) –

• body (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

update_audit_configuration(body, params=None, headers=None)

Updates the audit configuration.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• body (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

update_configuration(body, params=None, headers=None)

Adds or updates the existing configuration using the REST API.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• body (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any

update_distinguished_names(cluster_name, body=None, params=None, headers=None)

Adds or updates the specified distinguished names in the cluster’s or node’s allow list.

Parameters:

• error_trace – Whether to include the stack trace of returned errors.

• filter_path – Comma-separated list of filters used to reduce the response.

• human – Whether to return human readable values for statistics.

• pretty – Whether to pretty format the returned JSON response.

• source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

• cluster_name (Any) –

• body (Any) –

• params (Any) –

• headers (Any) –

Return type:

Any