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

オンライン編集

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

重要: この REST API 呼び出しは、シングル・サインオン認証が有効になっている場合は機能しません。 トークンを表示するには License Metric Tool にログインし、 ユーザーアイコン ユーザー・アイコン にカーソルを合わせ、 プロファイルをクリックします。 次に、 「トークンの表示」をクリックします。

リソース URL

https://server_url:server_port/api/get_token

リソース情報

表 1. リソース情報
操作の詳細 説明
目的 認証トークンを返します
HTTP メソッド POST
要求ヘッダー
Accept-Language (オプション)
  • 使用: 応答の言語をネゴシエーションするために使用されます。 このヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。
  • 値: en-US (英語のみがサポートされます)
要求ペイロード 
{
    "user" : "username",
    "password" : "password"
}
要求 Content-Type
  • application/json
応答ヘッダー
Content-Type
  • 使用法: 応答のコンテンツ・タイプを指定します。
  • 値: application/json
Content-Language
  • 使用法: 応答コンテンツの言語を指定します。 このヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。
  • 値: en-US、...
応答ペイロード Token要素
応答の Content-Type
  • application/json
正常な HTTP 応答コード
  • 200 – OK
エラーの HTTP 応答コード
  • 500 – “Bad Request” (照会パラメーターにエラーがあるか、照会パラメーターが欠落している場合)

メッセージの本文にはエラー・メッセージと詳細が含まれます。

会話例

以下の例では、APIリクエストのネゴシエーションに cURL コマンドラインツールを使用している。 トークンを取得するには、以下の POST 。

要求
curl -k -X POST -H "Content-Type: application/json" -H "Accept: application/json" 
-d {\"user\":\"username\",\"password\":\"userpassword\"} https://server_url:server_port/api/get_token
各項目の意味は次のとおりです。
-k
証明書の検証手順を無効にするには、このオプションを使用する。 License Metric Tool 証明書の検証手順を無効にします。
-H
要求のヘッダーを指定します。
-X
HTTP リクエストのタイプを指定する。
-d
認証用のJSONペイロードが含まれます。
username
認証用のユーザ名。
userpassword
指定したユーザーのパスワード。
SERVER_URL
がホストされているサーバーのアドレス。 License Metric Tool がホストされているサーバのアドレス。
server_port
サービスが実行されているポート番号。 License Metric Tool サービスが実行されているポート番号。
応答
{
"token":"<token>"
}