From 057f4cc7a2b262318f53eb01cbfe7f07cf00e203 Mon Sep 17 00:00:00 2001 From: gchaps <33642766+gchaps@users.noreply.github.com> Date: Tue, 29 Sep 2020 12:24:37 -0700 Subject: [PATCH] Added clarification on b64 encoding of API key (#78394) (#78841) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Added clarification on b64 encoding of API key The current documentation does not specify how to encode the response to get a valid api key, I added it from the info found here: https://github.com/elastic/elasticsearch/issues/50235#issuecomment-644170902 * Updated for consistency with Elasticsearch docs https://github.com/elastic/kibana/pull/78394#pullrequestreview-497412674 Co-authored-by: Théo Frasquet --- docs/user/security/api-keys/index.asciidoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/user/security/api-keys/index.asciidoc b/docs/user/security/api-keys/index.asciidoc index c93d7caec1b7d..7cf1b964082d9 100644 --- a/docs/user/security/api-keys/index.asciidoc +++ b/docs/user/security/api-keys/index.asciidoc @@ -72,9 +72,9 @@ The response should look something like this: "api_key" : "FD6P5UA4QCWlZZQhYF3YGw" } -Now, you can use the API key to request {kib} roles. You will need -to base64-encode the `id` and `api_key` provided in the response -and add it to your request as an authorization header. For example: +Now, you can use the API key to request {kib} roles. You'll need to send a request with a +`Authorization` header with a value having the prefix `ApiKey` followed by the credentials, +where credentials is the base64 encoding of `id` and `api_key` joined by a colon. For example: [source,js] curl --location --request GET 'http://localhost:5601/api/security/role' \