Help Center/ Cloud Search Service/ User Guide/ Working with Kibana/ Creating a User and Granting Permissions by Using Kibana
Updated on 2023-03-15 GMT+08:00

Creating a User and Granting Permissions by Using Kibana

Prerequisites

The security mode has been enabled for the cluster.

Description

Table 1 Parameters for creating a user and assigning permissions on Kibana

Parameter

Description

Permission

Single action, for example, creating an index (for example, indices:admin/create)

Action group

A group of permissions. For example, the predefined SEARCH action group grants roles permissions to use _search and _msearchAPI.

Role

A role is a combination of permissions and action groups, including operation permissions on clusters, indexes, documents, or fields.

Backend role

(Optional) Other external roles from the backend such as LDAP/Active Directory

User

A user can send operation requests to the Elasticsearch cluster. The user has credentials such as username and password, zero or more backend roles, and zero or more custom attributes.

Role mapping

A user will be assigned a role after successful authentication. Role mapping is to map a role to a user (or a backend role). For example, the mapping from kibana_user (role) to jdoe (user) means that John Doe obtains all permissions of kibana_user after being authenticated by kibana_user. Similarly, the mapping from all_access (role) to admin (backend role) means that any user with the backend role admin (from the LDAP/Active Directory server) has all the permissions of role all_access after being authenticated. You can map each role to multiple users or backend roles.

Procedure

  • The Kibana UI varies depending on the Kibana version, but their operations are similar. This section takes Kibana 7.6.2 as an example to describe the procedure.
  • You can customize the username, role name, and tenant name in Kibana. Chinese characters are not allowed.
  1. Log in to the CSS management console.
  2. Choose Clusters in the navigation pane. On the Clusters page, locate the target cluster and click Access Kibana in the Operation column.
    Enter the administrator username and password to log in to Kibana.
    • Username: admin (default administrator account name)
    • Password: Enter the administrator password you set when creating the cluster in security mode.
    Figure 1 Login page
  3. Click the Security icon on the Kibana operation page.
    Figure 2 Going to the Security page
  4. Create a user.
    1. Choose Authentication Backends > Internal Users Database.
      Figure 3 Adding a user (1)
    2. On the Internal Users Database page, choose . The page for adding user information is displayed.
      Figure 4 Adding a user (2)
    3. On the user creation page, configure Username and Password, and click Submit.

      The user will be displayed in the user list.

  5. Configure roles and permissions for the user.
    1. Click Roles.
      Figure 5 Adding a role
    2. On the Open Distro Security Roles page, click .
      1. Enter a role name on the Overview page.
        Figure 6 Entering a role name
      2. Configure CSS cluster permissions on the Cluster Permissions page. You can skip this step.
      3. Configure index permissions on the Index Permissions page.
        Index patterns: Set this parameter to the name of the index whose permission needs to be configured. For example, my_store.

        Use different names for the index and the user.

        Configure Permissions: Action Groups as required, for example, select the read-only permission Search.

      4. Retain the default settings on the Tenant Permissions page.

        After the configuration is complete, the role will be displayed.

  6. Assign a role to the user.
    1. Click Role Mappings.
      Figure 7 Role mapping
    2. Click to add the mapping between users and roles.
      Figure 8 Users and roles
    3. Click Submit.
  7. Verify that the configuration takes effect in Kibana.