Path parameters

• namespacestring Required

  The name of the namespace. Omit this parameter to retrieve information about all service accounts. If you omit this parameter, you must also omit the service parameter.
• servicestring Required

  The service name. Omit this parameter to retrieve information about all service accounts that belong to the specified namespace.

Responses

• 200 application/json
  Hide response attribute Show response attribute object

  • *object Additional properties
    Hide * attribute Show * attribute object

    • role_descriptorobject Required
      Hide role_descriptor attributes Show role_descriptor attributes object

      • clusterarray[string] Required

        A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute.

      • indicesarray[object] Required

        A list of indices permissions entries.

        Hide indices attributes Show indices attributes object

        • field_securityobject
          Hide field_security attributes Show field_security attributes object

          • exceptstring | array[string]
          • grantstring | array[string]

        • namesstring | array[string]

          A list of indices (or index name patterns) to which the permissions in this entry apply.

          One of:

          IndexNamestringarray-2array[string]
        • privilegesarray[string] Required

          The index level privileges that owners of the role have on the specified indices.

        • querystring | object

          While creating or updating a role you can provide either a JSON structure or a string to the API. However, the response provided by Elasticsearch will only be string with a json-as-text content.

          Since this is embedded in IndicesPrivileges, the same structure is used for clarity in both contexts.

          One of:

          IndicesPrivilegesQuerystringQueryContainerobjectRoleTemplateQueryobject

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
        • allow_restricted_indicesboolean Generally available

          Set to true if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the names list, Elasticsearch checks privileges against these indices regardless of the value set for allow_restricted_indices.

      • remote_indicesarray[object] Generally available; Added in 8.14.0

        A list of indices permissions for remote clusters.

        The subset of index level privileges that can be defined for remote clusters.

        Hide remote_indices attributes Show remote_indices attributes object

        • clustersstring | array[string] Required
        • field_securityobject
          Hide field_security attributes Show field_security attributes object

          • exceptstring | array[string]
          • grantstring | array[string]

        • namesstring | array[string]

          A list of indices (or index name patterns) to which the permissions in this entry apply.

          One of:

          IndexNamestringarray-2array[string]
        • privilegesarray[string] Required

          The index level privileges that owners of the role have on the specified indices.

        • querystring | object

          While creating or updating a role you can provide either a JSON structure or a string to the API. However, the response provided by Elasticsearch will only be string with a json-as-text content.

          Since this is embedded in IndicesPrivileges, the same structure is used for clarity in both contexts.

          One of:

          IndicesPrivilegesQuerystringQueryContainerobjectRoleTemplateQueryobject

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
        • allow_restricted_indicesboolean Generally available

          Set to true if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the names list, Elasticsearch checks privileges against these indices regardless of the value set for allow_restricted_indices.

      • remote_clusterarray[object] Generally available; Added in 8.15.0

        A list of cluster permissions for remote clusters. NOTE: This is limited a subset of the cluster permissions.

        The subset of cluster level privileges that can be defined for remote clusters.

        Hide remote_cluster attributes Show remote_cluster attributes object

        • clustersstring | array[string] Required
        • privilegesarray[string] Required

          The cluster level privileges that owners of the role have on the remote cluster.

          Values are monitor_enrich or monitor_stats.

      • globalarray[object] | object

        An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware. Support for global privileges is currently limited to the management of application privileges.

        One of:

        array-1array[object]GlobalPrivilegeobject

        Hide attribute Show attribute object

        • applicationobject Required

        Hide attribute Show attribute

        • applicationobject Required
          Hide application attribute Show application attribute object

          • manageobject Required
      • applicationsarray[object]

        A list of application privilege entries

        Hide applications attributes Show applications attributes object

        • applicationstring Required

          The name of the application to which this entry applies.

        • privilegesarray[string] Required

          A list of strings, where each element is the name of an application privilege or action.

        • resourcesarray[string] Required

          A list resources to which the privileges are applied.

      • metadataobject
        Hide metadata attribute Show metadata attribute object
      • run_asarray[string]

        A list of users that the API keys can impersonate.

      • descriptionstring

        An optional description of the role descriptor.

      • restrictionobject
        Hide restriction attribute Show restriction attribute object

        • workflowsarray[string] Required

          A list of workflows to which the API key is restricted. NOTE: In order to use a role restriction, an API key must be created with a single role descriptor.

      • transient_metadataobject
        Hide transient_metadata attribute Show transient_metadata attribute object