---
type: api
title: Get security index settings
description: Get the user-configurable settings for the security internal index (`.security` and associated indices).
url: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/elasticsearch/v8/operation/operation-security-get-settings
resource: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/elasticsearch/v8/operation/operation-security-get-settings
products:
  - Elasticsearch
---

# Get security index settings

## Paths

- `GET` `/_security/settings`

## Description

Get the user-configurable settings for the security internal index (`.security` and associated indices).
Only a subset of the index settings — those that are user-configurable—will be shown.
This includes:

* `index.auto_expand_replicas`
* `index.number_of_replicas`

## Required authorization

- Cluster privileges: `read_security`

## Authentication

- Api key: `Authorization: <value>`
  Elasticsearch APIs support key-based authentication.
  You must create an API key and use the encoded value in the request header.
  For example:
  
  
  ```
  curl -X GET "${ES_URL}/_cat/indices?v=true" \
    -H "Authorization: ApiKey ${API_KEY}"
  ```
  
  To get API keys, use the `/_security/api_key` APIs.
- Basic: `Authorization: Basic <credentials>`
- Bearer: `Authorization: Bearer <token>`
  Elasticsearch APIs support the use of bearer tokens in the `Authorization` HTTP header to authenticate with the API.
  For examples, refer to [Token-based authentication services](https://www.elastic.co/guide/en/elasticsearch/reference/current/token-authentication-services.html)

## Query string parameters

- `master_timeout` (string · default: 30s) — optional
  Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error.

## Response

`application/json`

- `security` (object)
  Settings for the index used for most security configuration, including native realm users and roles configured with the API.
  - `index` (object)
- `security-profile` (object)
  Settings for the index used to store profile information.
  - `index` (object)
- `security-tokens` (object)
  Settings for the index used to store tokens.
  - `index` (object)
## Code examples

#### Console

```console
GET /_security/settings
```

#### JavaScript

```javascript
const response = await client.security.getSettings();
```

#### Python

```python
resp = client.security.get_settings()
```

#### curl

```curl
curl -X GET "$ELASTICSEARCH_URL/_security/settings" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"
```

#### Java

```java
client.security().getSettings(g -> g);
```

#### C#

```c#
var response = await client.Security.GetSettingsAsync();
```

#### PHP

```php
$resp = $client->security()->getSettings();
```

#### Ruby

```ruby
response = client.security.get_settings
```