このページで

4 APIトークン

概要

このセクションでは、APIトークンの作成と管理を行えます。

APIトークンは、名前、トークンが割り当てられているユーザー、有効期限、トークンを作成したユーザー、またはステータス（有効/無効）で絞り込むことができます。リスト内のトークンのステータスをクリックすると、トークンをすばやく有効/無効にできます。また、リスト内でトークンを選択し、リストの下にある Enable/Disable ボタンをクリックすることで、トークンを一括で有効/無効にすることもできます。

新しいトークンを作成するには、右上隅にある Create API token ボタンを押し、トークン設定画面で必要な項目を入力します。

Parameter Description
Name トークンの表示名。
User トークンを割り当てるユーザー。ユーザーをすばやく選択するには、ユーザー名、名、または姓の入力を開始し、自動補完リストから必要なユーザーを選択します。あるいは、Select ボタンを押して、完全なユーザーリストからユーザーを選択することもできます。1つのトークンを割り当てられるユーザーは1人のみです。
Description 任意のトークンの説明。
Set expiration date and time トークンに有効期限を設定しない場合は、このチェックボックスをオフにします。
Expiry date カレンダーアイコンをクリックしてトークンの有効期限を選択するか、YYYY-MM-DD hh:mm:ss 形式で日付を手動入力します。
Enabled 無効状態のトークンを作成する必要がある場合は、このチェックボックスをオフにします。

トークンを作成するには Add を押します。次の画面で、ページを閉じる前に Auth token の値をコピーして安全な場所に保存し、その後 Close を押します。トークンがリストに表示されます。

Auth token の値は、後で再表示することはできません。利用できるのはトークン作成直後のみです。保存したトークンを紛失した場合は再生成する必要があり、その際には新しい認証文字列が作成されます。

トークン名をクリックすると、名前、説明、有効期限の設定、またはトークンのステータスを編集できます。なお、トークンの割り当て先ユーザーを変更することはできません。変更を保存するには Update ボタンを押します。トークンを紛失した場合や漏えいした場合は、Regenerate ボタンを押して新しいトークン値を生成できます。確認ダイアログボックスが表示され、この操作を確認するよう求められます。続行すると、以前に生成されたトークンは無効になります。

Administration メニューセクションにアクセスできないユーザーでも、user role の権限で Manage API tokens が許可されている場合に限り、User profile → API tokens section で自分に割り当てられたトークンの詳細を表示および変更できます。