23.1 認証トークンの取得

POST https://localhost:7007/auth/token

REST APIリクエストの認証に使用できる認証トークンを取得します。

リクエスト

リクエスト・ヘッダー

  • Accept: application/json; charset=UTF-8
  • Content-Type: application/json

表23-1 リクエスト本文のパラメータ

パラメータ 説明 必須
username string ユーザー名 はい
password string ユーザーのパスワード はい
createSession boolean セッションを作成する必要があるかどうかを確認する オプション。グラフ・サーバー(PGX)に対して問合せを実行する場合は、trueに設定します。
source string クライアントを識別する説明文字列 オプション。ソース値は空白なしで入力してください(例: commandLine、JShell、PythonShellまたはAPIClientTools)。
sessionId string グラフ・サーバーへの接続時に既存のセッションを再利用します オプション。セッションを再利用する場合は、既存のセッションIDに設定します。

サンプル・リクエスト本文

{
    "username": "graphuser",
    "password": "<password_for_graphuser>",
    "createSession": true,
    "source": "<source-value-for-pgx-session>",
    "sessionId": "<session-id>"
}

レスポンス

  • 201 Created
  • Content-Type: application/json

サンプル・レスポンス本文

{
    "access_token": "<token>"
    "token_type": "bearer",
    "expires_in": 3600
}

cURLの例

curl --location 'https://localhost:7007/auth/token' \
--header 'Content-Type: application/json' \
--data '{ 
    "username": "graphuser",
    "password": "<password_for_graphuser>",
    "createSession": true,
    "source": "commandLine",
    "sessionId": "<session-id>"
}'