認証トークンを取得するための REST API

REST API 要求を認証するために必要なユーザー固有のトークンを要求するには、api/get_token エレメントに対して POST 操作を使用します。

ユーザー固有のトークンを要求するには、次の URL を使用します。

https://hostname:port/api/get_token

重要: この REST API 呼び出しは、シングル・サインオン認証が有効になっている場合は機能しません。トークンを表示するには、BigFix Inventory にログインして「ユーザー」アイコン

にカーソルを移動して、「プロファイル」をクリックします。次に、「トークンの表示」をクリックします。

表 1. 操作の説明
操作の詳細	「説明」
操作	`POST /api/get_token`
目的	認証トークンを返します
HTTP メソッド	`POST`
リソース URI	https://`server_host_name`:`port_number`/api/get_token
URL リンク関係	n/a
URI 照会パラメーター	n/a
要求ヘッダー	ヘッダー `Accept-Language` (オプション) 値 en-US (英語のみをサポート) 応答の言語のネゴシエーションに使用されます。このヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。
要求ペイロード	`{ "user" : "username", "password" : "password" }`
要求 `Content-Type`	`application/json`
応答ヘッダー	ヘッダー `Content-Type` 値 `application/json` 応答のコンテンツ・タイプを指定します。
応答ヘッダー	ヘッダー `Content-Language` 値 en-US, … 応答のコンテンツの言語を指定します。このヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。
応答ペイロード	`Token` element
応答 `Content-Type`	`application/json`
正常な HTTP 応答コード	`200 – OK`
エラーの HTTP 応答コード	`401 – “Unauthorized”` 入力されたユーザー名とパスワードに一致するユーザーが存在しません。Active Directory を使用している場合は、ユーザー名の後にドメイン名 (例: username@domain.com) が続いていることを確認してください。

HTTP 会話の例

要求

POST api/get_token
Host: localhost:9081
Accept: application/json
Accept-Language: en-US

要求ヘッダー

Content-Type: application/json

要求ペイロード

{
	"user" : "admin",
	"password" : "password"
}

応答ヘッダー

HTTP/1.1 200 OK
Content-Type: application/json
Content-Language: en-US

応答の本文 (JSON)

{
"token":"44072fb20fbe38322b5e67a7e780978e20abbc80"
}