API key management in Elasticsearch - Time & Space Complexity

Time Complexity: API key management

O(n)

Understanding Time Complexity

When managing API keys in Elasticsearch, it's important to understand how the time to create, retrieve, or invalidate keys changes as the number of keys grows.

We want to know how the system handles more keys and how that affects performance.

Scenario Under Consideration

Analyze the time complexity of the following Elasticsearch API key retrieval query.

POST /_security/api_key/_query
{
  "query": {
    "term": {
      "name": "my-api-key"
    }
  }
}
    

This code searches for an API key by its name in the security index.

Identify Repeating Operations

In this query, Elasticsearch scans the index storing API keys to find matches.

• Primary operation: Searching through API key documents in the index.
• How many times: Once per query, but internally it may check many documents depending on the index size.

How Execution Grows With Input

As the number of API keys increases, the search may need to check more documents to find the matching key.

Input Size (n)	Approx. Operations
10	About 10 checks
100	About 100 checks
1000	About 1000 checks

Pattern observation: The number of operations grows roughly in direct proportion to the number of API keys stored.

Final Time Complexity

Time Complexity: O(n)

This means the time to find an API key grows linearly with the number of keys stored.

Common Mistake

[X] Wrong: "Searching for an API key always takes the same time no matter how many keys exist."

[OK] Correct: The search time depends on how many keys are stored because Elasticsearch must check documents to find matches.

Interview Connect

Understanding how search operations scale with data size helps you explain system behavior clearly and shows you can think about performance in real applications.

Self-Check

"What if the API keys were indexed with a unique ID and the query used that ID instead of the name? How would the time complexity change?"

Practice

1. What is the primary purpose of an API key in Elasticsearch?

easy

A. To monitor Elasticsearch cluster health

B. To store data inside Elasticsearch indices

C. To allow applications to securely access Elasticsearch with specific permissions

D. To backup Elasticsearch data automatically

Solution

1. Step 1: Understand API key role

   API keys are secret tokens used to authenticate and authorize applications.

2. Step 2: Identify purpose in Elasticsearch

   They grant controlled access to Elasticsearch resources based on assigned roles.

3. Final Answer:

   To allow applications to securely access Elasticsearch with specific permissions -> Option C

4. Quick Check:

   API key = secure app access [OK]

Hint: API keys control app access permissions [OK]

Common Mistakes:

• Confusing API keys with data storage
• Thinking API keys monitor cluster health
• Assuming API keys handle backups

2. Which of the following is the correct Elasticsearch API call to create an API key?

easy

A. DELETE /_security/api_key

B. GET /_security/api_key/create

C. PUT /_security/api_key

D. POST /_security/api_key

Solution

1. Step 1: Recall API key creation syntax

   Elasticsearch uses POST method to create resources like API keys.

2. Step 2: Match correct endpoint

   The correct endpoint for creating an API key is POST /_security/api_key.

3. Final Answer:

   POST /_security/api_key -> Option D

4. Quick Check:

   POST + /_security/api_key = create key [OK]

Hint: Use POST to create API keys in Elasticsearch [OK]

Common Mistakes:

• Using GET or DELETE for creation
• Confusing endpoint paths
• Using PUT instead of POST

3. Given this API key creation request body, what will be the name of the created API key?

{
  "name": "my-app-key",
  "role_descriptors": {
    "my-role": {
      "cluster": ["all"],
      "index": [{"names": ["logs-*"], "privileges": ["read"]}]
    }
  }
}

medium

A. my-app-key

B. my-role

C. logs-*

D. all

Solution

1. Step 1: Identify the API key name field

   The "name" field in the request body sets the API key's name.

2. Step 2: Read the value of the "name" field

   The value is "my-app-key", which becomes the API key's name.

3. Final Answer:

   my-app-key -> Option A

4. Quick Check:

   API key name = "name" field value [OK]

Hint: API key name is in the "name" field [OK]

Common Mistakes:

• Confusing role name with API key name
• Using index pattern as key name
• Mistaking privileges for name

4. You try to delete an API key using this request: DELETE /_security/api_key?id=12345 but get an error. What is the likely cause?

medium

A. API key names cannot be deleted, only IDs

B. API key ID must be passed in the request body, not as a query parameter

C. DELETE method is not supported for API keys

D. You must use GET method to delete API keys

Solution

1. Step 1: Check API key deletion syntax

   Elasticsearch requires the API key ID in the request body JSON, not as a URL query parameter.

2. Step 2: Understand method support

   DELETE method is supported, but parameters must be correctly passed in the body.

3. Final Answer:

   API key ID must be passed in the request body, not as a query parameter -> Option B

4. Quick Check:

   Delete API key ID in body, not URL [OK]

Hint: Pass API key ID in JSON body for deletion [OK]

Common Mistakes:

• Passing ID as URL query parameter
• Using wrong HTTP method
• Confusing API key name with ID

5. You want to create an API key that only allows reading from indices starting with "sales-" and no cluster privileges. Which role descriptor is correct in the request body?

hard

A. { "role_descriptors": { "read_sales": { "cluster": [], "index": [{ "names": ["sales-*"], "privileges": ["read"] }] } } }

B. { "role_descriptors": { "read_sales": { "cluster": ["all"], "index": [{ "names": ["sales-*"], "privileges": ["write"] }] } } }

C. { "role_descriptors": { "read_sales": { "cluster": ["monitor"], "index": [{ "names": ["sales-*"], "privileges": ["all"] }] } } }

D. { "role_descriptors": { "read_sales": { "cluster": ["all"], "index": [{ "names": ["*"], "privileges": ["read"] }] } } }

Solution

1. Step 1: Identify required privileges

   The API key should have no cluster privileges and only read privileges on indices starting with "sales-".

2. Step 2: Match role descriptor to requirements

   { "role_descriptors": { "read_sales": { "cluster": [], "index": [{ "names": ["sales-*"], "privileges": ["read"] }] } } } has empty cluster privileges and read privilege on "sales-*" indices, matching the requirement.

3. Final Answer:

   { "role_descriptors": { "read_sales": { "cluster": [], "index": [{ "names": ["sales-*"], "privileges": ["read"] }] } } } -> Option A

4. Quick Check:

   No cluster + read sales-* = { "role_descriptors": { "read_sales": { "cluster": [], "index": [{ "names": ["sales-*"], "privileges": ["read"] }] } } } [OK]

Hint: Empty cluster array means no cluster privileges [OK]

Common Mistakes:

• Giving cluster all privileges by mistake
• Using write or all privileges instead of read
• Applying privileges to wrong index patterns