認証（Authenticate）

Authenticate API

ユーザーを認証し、認証されたユーザーに関する情報を取得するために、基本認証ヘッダーを使用してリクエストを送信できるようにします。

Request

GET /_security/_authenticate

Description

成功した呼び出しは、ユーザー名、ユーザーに割り当てられた役割、割り当てられたメタデータ、ユーザーを認証および承認した領域に関する情報など、ユーザー情報を示すJSON構造を返します。

Response codes

ユーザーが認証できない場合、このAPIは401ステータスコードを返します。

Examples

ユーザーを認証するには、/_security/_authenticateエンドポイントにGETリクエストを送信します:

Python

resp = client.security.authenticate()
print(resp)

Js

const response = await client.security.authenticate();
console.log(response);

Console

GET /_security/_authenticate

次の例の出力は、ユーザー「rdeniro」に関する情報を提供します:

Console-Result

{
  "username": "rdeniro",
  "roles": [
   "admin"
  ],
  "full_name": null,
  "email":  null,
  "metadata": { },
  "enabled": true,
  "authentication_realm": {
   "name" : "file",
   "type" : "file"
  },
  "lookup_realm": {
   "name" : "file",
   "type" : "file"
  },
  "authentication_type": "realm"
}