Namespace: API-Security

API-Security

Source:

Methods

(static) SecurityApi#changePassword(params, options, callback) → {Object|Promise.<never>|*}

Changes the password for the current user.
See Also: - Security - Change Password
Parameters:
Name Type Description
params Object
Properties
Name Type Description
body Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#createActionGroup(params, options, callback) → {Object|Promise.<never>|*}

Creates or replaces the specified action group.
See Also: - Security - Create Action Group
Parameters:
Name Type Description
params Object
Properties
Name Type Description
action_group string The name of the action group to create or replace
body Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#createRole(params, options, callback) → {Object|Promise.<never>|*}

Creates or replaces the specified role.
See Also: - Security - Create Role
Parameters:
Name Type Description
params Object
Properties
Name Type Description
role string
body Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#createRoleMapping(params, options, callback) → {Object|Promise.<never>|*}

Creates or replaces the specified role mapping.
See Also: - Security - Create Role Mapping
Parameters:
Name Type Description
params Object
Properties
Name Type Description
role string
body Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#createTenant(params, options, callback) → {Object|Promise.<never>|*}

Creates or replaces the specified tenant.
See Also: - Security - Create Tenant
Parameters:
Name Type Description
params Object
Properties
Name Type Description
tenant string
body Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#createUser(params, options, callback) → {Object|Promise.<never>|*}

Creates or replaces the specified user.
See Also: - Security - Create User
Parameters:
Name Type Description
params Object
Properties
Name Type Description
username string
body Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#deleteActionGroup(params, options, callback) → {Object|Promise.<never>|*}

Delete a specified action group.
See Also: - Security - Delete Action Group
Parameters:
Name Type Description
params Object
Properties
Name Type Description
action_group string Action group to delete.
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#deleteDistinguishedNames(params, options, callback) → {Object|Promise.<never>|*}

Deletes all distinguished names in the specified cluster’s or node’s allow list.
See Also: - Security - Delete Distinguished Names
Parameters:
Name Type Description
params Object
Properties
Name Type Description
cluster_name string
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#deleteRole(params, options, callback) → {Object|Promise.<never>|*}

Delete the specified role.
See Also: - Security - Delete Role
Parameters:
Name Type Description
params Object
Properties
Name Type Description
role string
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#deleteRoleMapping(params, options, callback) → {Object|Promise.<never>|*}

Deletes the specified role mapping.
See Also: - Security - Delete Role Mapping
Parameters:
Name Type Description
params Object
Properties
Name Type Description
role string
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#deleteTenant(params, options, callback) → {Object|Promise.<never>|*}

Delete the specified tenant.
See Also: - Security - Delete Tenant
Parameters:
Name Type Description
params Object
Properties
Name Type Description
tenant string
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#deleteUser(params, options, callback) → {Object|Promise.<never>|*}

Delete the specified user.
See Also: - Security - Delete User
Parameters:
Name Type Description
params Object
Properties
Name Type Description
username string
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#flushCache(params, options, callback) → {Object|Promise.<never>|*}

Flushes the Security plugin user, authentication, and authorization cache.
See Also: - Security - Flush Cache
Parameters:
Name Type Description
params Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#getAccountDetails(params, options, callback) → {Object|Promise.<never>|*}

Returns account details for the current user.
See Also: - Security - Get Account Details
Parameters:
Name Type Description
params Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#getActionGroup(params, options, callback) → {Object|Promise.<never>|*}

Retrieves one action group.
See Also: - Security - Get Action Group
Parameters:
Name Type Description
params Object
Properties
Name Type Description
action_group string Action group to retrieve.
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#getActionGroups(params, options, callback) → {Object|Promise.<never>|*}

Retrieves all action groups.
See Also: - Security - Get Action Groups
Parameters:
Name Type Description
params Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#getAuditConfiguration(params, options, callback) → {Object|Promise.<never>|*}

Retrieves the audit configuration.
See Also: - Security - Get Audit Configuration
Parameters:
Name Type Description
params Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#getCertificates(params, options, callback) → {Object|Promise.<never>|*}

Retrieves the cluster’s security certificates.
See Also: - Security - Get Certificates
Parameters:
Name Type Description
params Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#getConfiguration(params, options, callback) → {Object|Promise.<never>|*}

Returns the current Security plugin configuration in JSON format.
See Also: - Security - Get Configuration
Parameters:
Name Type Description
params Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#getDistinguishedNames(params, options, callback) → {Object|Promise.<never>|*}

Retrieves all distinguished names in the allow list.
See Also: - Security - Get Distinguished Names
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
cluster_name string <optional>
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#getRole(params, options, callback) → {Object|Promise.<never>|*}

Retrieves one role.
See Also: - Security - Get Role
Parameters:
Name Type Description
params Object
Properties
Name Type Description
role string
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#getRoleMapping(params, options, callback) → {Object|Promise.<never>|*}

Retrieves one role mapping.
See Also: - Security - Get Role Mapping
Parameters:
Name Type Description
params Object
Properties
Name Type Description
role string
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#getRoleMappings(params, options, callback) → {Object|Promise.<never>|*}

Retrieves all role mappings.
See Also: - Security - Get Role Mappings
Parameters:
Name Type Description
params Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#getRoles(params, options, callback) → {Object|Promise.<never>|*}

Retrieves all roles.
See Also: - Security - Get Roles
Parameters:
Name Type Description
params Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#getTenant(params, options, callback) → {Object|Promise.<never>|*}

Retrieves one tenant.
See Also: - Security - Get Tenant
Parameters:
Name Type Description
params Object
Properties
Name Type Description
tenant string
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#getTenants(params, options, callback) → {Object|Promise.<never>|*}

Retrieves all tenants.
See Also: - Security - Get Tenants
Parameters:
Name Type Description
params Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#getUser(params, options, callback) → {Object|Promise.<never>|*}

Retrieve one internal user.
See Also: - Security - Get User
Parameters:
Name Type Description
params Object
Properties
Name Type Description
username string
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#getUsers(params, options, callback) → {Object|Promise.<never>|*}

Retrieve all internal users.
See Also: - Security - Get Users
Parameters:
Name Type Description
params Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#health(params, options, callback) → {Object|Promise.<never>|*}

Checks to see if the Security plugin is up and running.
See Also: - Security - Health
Parameters:
Name Type Description
params Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#patchActionGroup(params, options, callback) → {Object|Promise.<never>|*}

Updates individual attributes of an action group.
See Also: - Security - Patch Action Group
Parameters:
Name Type Description
params Object
Properties
Name Type Description
action_group string
body Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#patchActionGroups(params, options, callback) → {Object|Promise.<never>|*}

Creates, updates, or deletes multiple action groups in a single call.
See Also: - Security - Patch Action Groups
Parameters:
Name Type Description
params Object
Properties
Name Type Description
body Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#patchAuditConfiguration(params, options, callback) → {Object|Promise.<never>|*}

A PATCH call is used to update specified fields in the audit configuration.
See Also: - Security - Patch Audit Configuration
Parameters:
Name Type Description
params Object
Properties
Name Type Description
body Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#patchConfiguration(params, options, callback) → {Object|Promise.<never>|*}

A PATCH call is used to update the existing configuration using the REST API.
See Also: - Security - Patch Configuration
Parameters:
Name Type Description
params Object
Properties
Name Type Description
body Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#patchDistinguishedNames(params, options, callback) → {Object|Promise.<never>|*}

Bulk update of distinguished names.
See Also: - Security - Patch Distinguished Names
Parameters:
Name Type Description
params Object
Properties
Name Type Description
body Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#patchRole(params, options, callback) → {Object|Promise.<never>|*}

Updates individual attributes of a role.
See Also: - Security - Patch Role
Parameters:
Name Type Description
params Object
Properties
Name Type Description
role string
body Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#patchRoleMapping(params, options, callback) → {Object|Promise.<never>|*}

Updates individual attributes of a role mapping.
See Also: - Security - Patch Role Mapping
Parameters:
Name Type Description
params Object
Properties
Name Type Description
role string
body Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#patchRoleMappings(params, options, callback) → {Object|Promise.<never>|*}

Creates or updates multiple role mappings in a single call.
See Also: - Security - Patch Role Mappings
Parameters:
Name Type Description
params Object
Properties
Name Type Description
body Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#patchRoles(params, options, callback) → {Object|Promise.<never>|*}

Creates, updates, or deletes multiple roles in a single call.
See Also: - Security - Patch Roles
Parameters:
Name Type Description
params Object
Properties
Name Type Description
body Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#patchTenant(params, options, callback) → {Object|Promise.<never>|*}

Add, delete, or modify a single tenant.
See Also: - Security - Patch Tenant
Parameters:
Name Type Description
params Object
Properties
Name Type Description
tenant string
body Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#patchTenants(params, options, callback) → {Object|Promise.<never>|*}

Add, delete, or modify multiple tenants in a single call.
See Also: - Security - Patch Tenants
Parameters:
Name Type Description
params Object
Properties
Name Type Description
body Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#patchUser(params, options, callback) → {Object|Promise.<never>|*}

Updates individual attributes of an internal user.
See Also: - Security - Patch User
Parameters:
Name Type Description
params Object
Properties
Name Type Description
username string
body Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#patchUsers(params, options, callback) → {Object|Promise.<never>|*}

Creates, updates, or deletes multiple internal users in a single call.
See Also: - Security - Patch Users
Parameters:
Name Type Description
params Object
Properties
Name Type Description
body Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#reloadHttpCertificates(params, options, callback) → {Object|Promise.<never>|*}

Reload HTTP layer communication certificates.
See Also: - Security - Reload Http Certificates
Parameters:
Name Type Description
params Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#reloadTransportCertificates(params, options, callback) → {Object|Promise.<never>|*}

Reload transport layer communication certificates.
See Also: - Security - Reload Transport Certificates
Parameters:
Name Type Description
params Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#updateAuditConfiguration(params, options, callback) → {Object|Promise.<never>|*}

Updates the audit configuration.
See Also: - Security - Update Audit Configuration
Parameters:
Name Type Description
params Object
Properties
Name Type Description
body Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#updateConfiguration(params, options, callback) → {Object|Promise.<never>|*}

Adds or updates the existing configuration using the REST API.
See Also: - Security - Update Configuration
Parameters:
Name Type Description
params Object
Properties
Name Type Description
body Object
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) SecurityApi#updateDistinguishedNames(params, options, callback) → {Object|Promise.<never>|*}

Adds or updates the specified distinguished names in the cluster’s or node’s allow list.
See Also: - Security - Update Distinguished Names
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
cluster_name string
body Object <optional>
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *