enroll-kibana.asciidoc 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. [[security-api-kibana-enrollment]]
  2. === Enroll {kib} API
  3. ++++
  4. <titleabbrev>Enroll {kib}</titleabbrev>
  5. ++++
  6. Enables a {kib} instance to configure itself for communication with a secured {es} cluster.
  7. [[security-api-kibana-enrollment-request]]
  8. ==== {api-request-title}
  9. `GET /_security/enroll/kibana`
  10. [[security-api-kibana-enrollment-desc]]
  11. ==== {api-description-title}
  12. Use this API to enable a {kib} instance to configure itself for communications
  13. with an {es} cluster that already has security features enabled.
  14. [[security-api-client-enrollment-examples]]
  15. ==== {api-examples-title}
  16. The following example shows how to enroll a {kib} instance.
  17. [source,console]
  18. ----
  19. GET /_security/enroll/kibana
  20. ----
  21. // TEST[skip:we need to enable HTTP TLS for the docs cluster]
  22. The API returns the following response:
  23. [source,console_result]
  24. ----
  25. {
  26. "password" : "longsecurepassword", <1>
  27. "http_ca" : "MIIJlAIBAzCCCVoGCSqGSIb3....vsDfsA3UZBAjEPfhubpQysAICCAA=", <2>
  28. }
  29. ----
  30. <1> The password for the `kibana_system` user.
  31. <2> The CA certificate used to sign the node certificates that {es} uses for TLS on the HTTP layer.
  32. The certificate is returned as a Base64 encoded string of the ASN.1 DER encoding of the certificate.