NAME

Search::Elasticsearch::Client::6_0::Direct::XPack::Security - Plugin providing Security API for Search::Elasticsearch 6.x

VERSION

version 7.30

SYNOPSIS

    my $response = $es->xpack->security->authenticate();

DESCRIPTION

This class extends the Search::Elasticsearch client with a security namespace, to support the Security APIs.

The full documentation for the Security feature is available here: https://www.elastic.co/guide/en/x-pack/current/xpack-security.html

GENERAL METHODS

authenticate()

    $response = $es->xpack->security->authenticate()

The authenticate() method checks that the userinfo is correct and returns a list of which roles are assigned to the user.

See the authenticate docs for more information.

Query string parameters: error_trace, human

clear_cached_realms()

    $response = $es->xpack->security->clear_cached_realms(
        realms => $realms       # required  (comma-separated string)
    );

The clear_cached_realms() method clears the caches for the specified realms

Query string parameters: error_trace, human, usernames

See the clear_cached_realms docs for more information.

USER METHODS

put_user()

    $response = $es->xpack->security->put_user(
        username => $username,     # required
        body     => {...}          # required
    );

The put_user() method creates a new user or updates an existing user.

See the User Management docs for more information.

Query string parameters: error_trace, human

get_user()

    $response = $es->xpack->security->get_user(
        username => $username | \@usernames     # optional
    );

The get_user() method retrieves info for the specified users (or all users).

See the User Management docs for more information.

Query string parameters: error_trace, human

delete_user()

    $response = $es->xpack->security->delete_user(
        username => $username       # required
    );

The delete_user() method deletes the specified user.

See the User Management docs for more information.

Query string parameters: error_trace, human

change_password()

    $response = $es->xpack->security->change_password(
        username => $username       # optional
        body => {
            password => $password   # required
        }
    )

The change_password() method changes the password for the specified user.

See the User Management docs for more information.

disable_user()

    $response = $es->xpack->security->disable_user(
        username => $username       # required
    );

The disable_user() method disables the specified user.

See the User Management docs for more information.

Query string parameters: error_trace, human

enable_user()

    $response = $es->xpack->security->enable_user(
        username => $username       # required
    );

The enable_user() method enables the specified user.

See the User Management docs for more information.

Query string parameters: error_trace, human

ROLE METHODS

put_role()

    $response = $es->xpack->security->put_role(
        name => $name,             # required
        body     => {...}          # required
    );

The put_role() method creates a new role or updates an existing role.

See the Role Management docs for more information.

Query string parameters: error_trace, human

get_role()

    $response = $es->xpack->security->get_role(
        name => $name | \@names     # optional
    );

The get_role() method retrieves info for the specified roles (or all roles).

See the Role Management docs for more information.

Query string parameters: error_trace, human

delete_role()

    $response = $es->xpack->security->delete_role(
        name => $name       # required
    );

The delete_role() method deletes the specified role.

See the Role Management docs for more information.

Query string parameters: error_trace, human

clear_cached_roles()

    $response = $es->xpack->security->clear_cached_roles(
        names => $names       # required  (comma-separated string)
    );

The clear_cached_roles() method clears the caches for the specified roles.

See the Role Management docs for more information.

Query string parameters: error_trace, human

ROLE MAPPING METHODS

put_role_mapping()

    $response = $es->xpack->security->put_role_mapping(
        name => $name,             # required
        body     => {...}          # required
    );

The put_role_mapping() method creates a new role mapping or updates an existing role mapping.

See the Role Mapping docs for more information.

Query string parameters: error_trace, human

get_role_mapping()

    $response = $es->xpack->security->get_role_mapping(
        name => $name,             # optional
    );

The get_role_mapping() method retrieves one or more role mappings.

See the Role Mapping docs for more information.

Query string parameters: error_trace, human

delete_role_mapping()

    $response = $es->xpack->security->delete_role_mapping(
        name => $name,             # required
    );

The delete_role_mapping() method deletes a role mapping.

See the Role Mapping docs for more information.

Query string parameters: error_trace, human

TOKEN METHODS

get_token()

    $response = $es->xpack->security->get_token(
        body     => {...}          # required
    );

The get_token() method enables you to create bearer tokens for access without requiring basic authentication.

See the Token Management docs for more information.

Query string parameters: error_trace, human

invalidate_token()

    $response = $es->xpack->security->invalidate_token(
        body     => {...}          # required
    );

The invalidate_token() method enables you to invalidate bearer tokens for access without requiring basic authentication.

See the Token Management docs for more information.

Query string parameters: error_trace, human

API KEY METHODS

create_api_key()

    $response = $es->xpack->security->create_api_key(
        body    => {...}            # required
    )

The create_api_key() API is used to create API keys which can be used for access instead of basic authentication.

Query string parameters: error_trace, filter_path, human, refresh

See the Create API Key docs for more.

get_api_key()

    $response = $es->xpack->security->get_api_key(
        id          => $id,         # optional
        name        => $name,       # optional
        realm_name  => $realm,      # optional
        username    => $username    # optional
    )

The get_api_key() API is used to get information about an API key.

Query string parameters: error_trace, filter_path, human, id, name, realm_name, username

See the Get API Key docs for more.

invalidate_api_key()

    $response = $es->xpack->security->invalidate_api_key(
        id          => $id,         # optional
        name        => $name,       # optional
        realm_name  => $realm,      # optional
        username    => $username    # optional
    )

The invalidate_api_key() API is used to invalidate an API key.

Query string parameters: error_trace, filter_path, human, id, name, realm_name, username

See the Invalidate API Key docs for more.

USER PRIVILEGE METHODS

get_user_privileges()

    $response = $es->xpack->get_user_privileges();

 The C<get_user_privileges()> method retrieves the privileges granted to the current user.

 Query string parameters:
    C<error_trace>,
    C<filter_path>,
    C<human>

has_privileges() $response = $es->xpack->has_privileges( user => $user, # optional body => {...} # required );

 The C<has_privileges()> method checks whether the current or specified user has the listed privileges.

 Query string parameters:
    C<error_trace>,
    C<filter_path>,
    C<human>

See the Has Privileges docs for more.

APPLICATION PRIVILEGE METHODS

put_privileges()

    $response = $es->xpack->put_privileges(
        application     => $application,    # required
        name            => $name,           # required
        body            => {...}            # required
    );

 The C<put_privileges()> method creates or updates the named privilege for a particular application.

 Query string parameters:
    C<error_trace>,
    C<filter_path>,
    C<human>,
    C<refresh>

See the Create or Update Application Privileges docs for more.

get_privileges()

    $response = $es->xpack->get_privileges(
        application     => $application,    # required
        name            => $name,           # required
    );

 The C<get_privileges()> method retrieves the named privilege for a particular application.

 Query string parameters:
    C<error_trace>,
    C<filter_path>,
    C<human>

See the Get Application Privileges docs for more.

delete_privileges()

    $response = $es->xpack->delete_privileges(
        application     => $application,    # required
        name            => $name,           # required
    );

 The C<delete_privileges()> method deletes the named privilege for a particular application.

 Query string parameters:
    C<error_trace>,
    C<filter_path>,
    C<human>,
    C<refresh>

See the Delete Application Privileges docs for more.

AUTHOR

Enrico Zimuel <enrico.zimuel@elastic.co>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2020 by Elasticsearch BV.

This is free software, licensed under:

  The Apache License, Version 2.0, January 2004