enroll-kibana.asciidoc 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. [[security-api-kibana-enrollment]]
  2. === Enroll {kib} API
  3. ++++
  4. <titleabbrev>Enroll {kib}</titleabbrev>
  5. ++++
  6. .New API reference
  7. [sidebar]
  8. --
  9. For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
  10. --
  11. Enables a {kib} instance to configure itself for communication with a secured {es} cluster.
  12. NOTE: This API is currently intended for internal use only by {kib}.
  13. [[security-api-kibana-enrollment-request]]
  14. ==== {api-request-title}
  15. `GET /_security/enroll/kibana`
  16. [[security-api-kibana-enrollment-desc]]
  17. ==== {api-description-title}
  18. {kib} uses this API internally to configure itself for communications with an
  19. {es} cluster that already has security features enabled.
  20. [[security-api-client-enrollment-examples]]
  21. ==== {api-examples-title}
  22. The following example shows how to enroll a {kib} instance.
  23. [source,console]
  24. ----
  25. GET /_security/enroll/kibana
  26. ----
  27. // TEST[skip:we need to enable HTTP TLS for the docs cluster]
  28. The API returns the following response:
  29. [source,console_result]
  30. ----
  31. {
  32. "token" : {
  33. "name" : "enroll-process-token-1629123923000", <1>
  34. "value": "AAEAAWVsYXN0aWM...vZmxlZXQtc2VydmVyL3Rva2VuMTo3TFdaSDZ" <2>
  35. },
  36. "http_ca" : "MIIJlAIBAzVoGCSqGSIb3...vsDfsA3UZBAjEPfhubpQysAICAA=", <3>
  37. }
  38. ----
  39. <1> The name of the bearer token for the `elastic/kibana` service account.
  40. <2> The value of the bearer token for the `elastic/kibana` service account.
  41. Use this value to {ref}/service-accounts.html#authenticate-with-service-account-token[authenticate the service account] with {es}.
  42. <3> The CA certificate used to sign the node certificates that {es} uses for TLS
  43. on the HTTP layer. The certificate is returned as a Base64 encoded string of the
  44. ASN.1 DER encoding of the certificate.