ユーザーの取得（Get users）

ユーザー取得API

ネイティブ領域および組み込みユーザーに関する情報を取得します。

リクエスト

GET /_security/user

GET /_security/user/<username>

前提条件

• このAPIを使用するには、少なくとも read_security クラスター権限が必要です。

説明

ネイティブ領域に関する詳細は、領域およびネイティブユーザー認証を参照してください。

パスパラメータ

• username
• （オプション、文字列）ユーザーの識別子。カンマ区切りのリストとして複数のユーザー名を指定できます。このパラメータを省略すると、APIはすべてのユーザーに関する情報を取得します。

クエリパラメータ

• with_profile_uid
• （オプション、ブール値）ユーザーのために、存在する場合はuser profile uidを取得するかどうかを決定します。デフォルトは false です。

レスポンスボディ

成功した呼び出しは、ユーザーのJSON表現を持つユーザーの配列を返します。ユーザーパスワードは含まれないことに注意してください。

レスポンスコード

ユーザーが native 領域に定義されていない場合、リクエストは404になります。

例

ネイティブユーザーを取得するには、/_security/user/<username> エンドポイントにGETリクエストを送信します:

Python

resp = client.security.get_user(
   username="jacknich",
)
print(resp)

Js

const response = await client.security.getUser({
  username: "jacknich",
});
console.log(response);

コンソール

GET /_security/user/jacknich

コンソール-結果

{
  "jacknich": {
   "username": "jacknich",
   "roles": [
   "admin", "other_role1"
   ],
   "full_name": "Jack Nicholson",
   "email": "[email protected]",
   "metadata": { "intelligence" : 7 },
   "enabled": true
  }
}

レスポンスの一部としてユーザー profile_uid を取得します:

Python

resp = client.security.get_user(
   username="jacknich",
   with_profile_uid=True,
)
print(resp)

Js

const response = await client.security.getUser({
  username: "jacknich",
  with_profile_uid: "true",
});
console.log(response);

コンソール

GET /_security/user/jacknich?with_profile_uid=true

コンソール-結果

{
  "jacknich": {
   "username": "jacknich",
   "roles": [
   "admin", "other_role1"
   ],
   "full_name": "Jack Nicholson",
   "email": "[email protected]",
   "metadata": { "intelligence" : 7 },
   "enabled": true,
   "profile_uid": "u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0"
  }
}

ユーザー名を省略してすべてのユーザーを取得します:

Python

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

Js

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

コンソール

GET /_security/user