4 APIトークン
概要
このセクションでは、APIトークンの作成と管理を行えます。
APIトークンは、名前、トークンが割り当てられているユーザー、有効期限、トークンを作成したユーザー、またはステータス（有効/無効）で絞り込むことができます。リスト内のトークンのステータスをクリックすると、トークンをすばやく有効/無効にできます。また、リスト内でトークンを選択し、リストの下にある Enable/Disable ボタンをクリックすることで、トークンを一括で有効/無効にすることもできます。
新しいトークンを作成するには、右上隅の Create API token ボタンを押し、トークン設定画面で必要な項目を入力します。
| Parameter | Description |
|---|---|
| 名前 | トークンの表示名。 |
| ユーザー | トークンを割り当てるユーザー。ユーザーをすばやく選択するには、ユーザー名、名、または姓の入力を開始し、自動補完リストから必要なユーザーを選択します。あるいは、Select ボタンを押して、完全なユーザー一覧からユーザーを選択することもできます。トークンを割り当てられるユーザーは1人のみです。 |
| 説明 | 任意のトークンの説明。 |
| 有効期限の日時を設定 | トークンに有効期限を設定しない場合は、このチェックボックスをオフにします。 |
| 有効期限 | カレンダーアイコンをクリックしてトークンの有効期限を選択するか、YYYY-MM-DD hh:mm:ss 形式で日付を手動入力します。 |
| 有効 | 無効状態のトークンを作成する必要がある場合は、このチェックボックスをオフにします。 |
トークンを作成するには、Add を押します。
Auth token の値をコピーし、ページを閉じる前に 安全な場所に保存してから、Close を押します。 トークンが一覧に表示されます。
Auth token の値は、後で再表示することはできません。 この値は、トークン作成直後にのみ利用可能です。保存したトークンを紛失した場合は再生成する必要があり、その際には新しい認証文字列が作成されます。
トークン名をクリックすると、名前、説明、有効期限の設定、またはトークンのステータスを編集できます。なお、トークンの割り当て先ユーザーを変更することはできません。変更を保存するには、Update ボタンを押します。トークンを紛失した場合や漏えいした場合は、Regenerate ボタンを押して新しいトークン値を生成できます。確認ダイアログが表示され、この操作を続行すると以前に生成されたトークンが無効になるため、確認を求められます。
Administration メニューセクションにアクセスできないユーザーでも、user role の権限で Manage API tokens が許可されている場合に限り、User profile → API tokens section で自分に割り当てられたトークンの詳細を表示および変更できます。