このページで

4 APIトークン

概要

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

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

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

Parameter Description
Name トークンの表示名。
User トークンを割り当てるユーザー。ユーザーをすばやく選択するには、ユーザー名、名、または姓の入力を開始し、候補の自動補完リストから必要なユーザーを選択します。あるいは、Select ボタンを押して、完全なユーザー一覧からユーザーを選択することもできます。トークンを割り当てられるユーザーは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 メニューセクションへのアクセス権がないユーザーでも、ユーザーの 権限 で Manage API tokens が許可されている場合に限り、User profile → API tokens セクション で自分に割り当てられたトークンの詳細を表示および変更できます。