HighBond アクセストークンの作成と管理

Launchpad プロファイルページから利用できる[API トークンを管理]ページで、個人の HighBond アクセストークンを作成または管理します。

アクセストークンとは?

アクセス トークンは、ユーザーを特定し、他のアプリケーションへのアクセスを認証する文字列です。

必要なアクセストークンは、以下のいずれを行う必要があるかに応じて異なります。

Analytics トークン

Analytics トークンは、Analytics を起動するたびに自動的に生成され、レジストリに保存されます。

  • Analytics 14 以前を使用する場合に、ACLGRC アクセス トークンを手動で作成すると、そのトークンの種類はLaunchpad 内で Analytics トークンとして分類されます。
  • Analytics 14.1 を使用する場合に、HighBond アクセス トークンを手動で作成すると、そのトークンの種類はLaunchpad 内で Analytics トークンとして分類されます。

機能の仕組み

Launchpad では、[API トークンを管理]ページに、生成したすべてのアクセストークンが表示されます。

API トークンを管理]ページを使用して、次のようにします。

  • トークンをコピーする
  • アクセス トークンの説明または特定するためのラベルを提供する
  • アクセス トークンをロックし、修正または削除できないようにする
  • アクセス トークンを削除する

注意

アクセス トークンは複数の権限を提供するため、安全な場所で秘密に保管しておくことが重要です。公共からアクセス可能な場所ではアクセス トークンを共有しないでください。

アクセス許可

いずれのユーザーも Analytics トークンを作成できます。HighBond API トークンまたはアクティビティログ API トークンを作成するには、1 つ以上の Diligent One インスタンスのシステム管理者である必要があります。

すべてのユーザーが自身のアクセストークンを管理できます。

アクセストークンを作成する

  1. Launchpad を開きます。
  2. メモ

    会社が Diligent One で複数のインスタンスを使用している場合は、該当するインスタンスがアクティブであることを確認します。

  3. [プロファイル]メニュー アイコン]>[プロファイル]を選択します。
  4. アプリケーション トークンの横で、[管理]をクリックします。[API トークンの管理]ページが開きます。
  5. +トークンを追加]をクリックし、ドロップダウンメニューから適切なオプションを選択します (例: HighBond API、Analytics、または Activity Logs API など)。[新しいトークン]サイド パネルが表示されます。
  6. サイド パネルのフィールドに必要事項を入力して、トークンを作成します。

    メモ

    トークンの作成には、[説明]フィールドを含むすべてのフィールドが必要です。ただし、トークンの有効期限を記載しない場合は例外です。その場合、トークンの有効期限はデフォルトで[なし]になるので、日数を記入する必要はありません。

    1. 説明を入力します。

      ヒント

      説明には、このトークンが使用されるすべての場所とその目的を含めてください。トークンは有効期限が切れると交換する必要があり、詳細な説明を加えることで、交換の手間を省くことができるからです。

    2. 省略可能。トークンの有効期限を有効または無効にします。

      メモ

      トークンの有効期限を設定する機能は、デフォルトで有効 (トグルオン) にする必要があります。無効にすると、トークンの有効期限が切れることはありません。

    3. トークンの作成日から最大 1 年(365 日)までの有効期限を設定する日数を入力します。
    4. 身元確認のために Diligent One アカウントのパスワードを入力します。
  7. トークンを生成]をクリックします。サイド パネルが更新され、トークンが正常に生成されたことを確認するメッセージが表示され、トークン ID、有効期限 (トークンが失効する日時)、説明が表示されます。
  8. コピー]をクリックします。[クリップボードにコピー]メッセージで、トークンが正常にコピーされたことを確認します。

    注意

    このサイド パネルを閉じる前にトークンを保存します。セキュリティ対策として、アクセスできるのはこの機会だけです。トークンを保存せずに忘れた場合は、新しいトークンを作成する必要があります。
  9. 閉じる]をクリックします。[新しいトークン]サイド パネルが閉じます。
  10. トークンをアプリケーションやスクリプトに貼り付けます。

    メモ

    トークンはパスワードのように扱い、他者とは共有しないでください。

API トークンを管理する

API トークンを管理]ページで、既存のトークン リストの表示、トークンの説明の編集、トークンのロック(編集や削除ができないようにする)、トークンの削除を行うことができます。

  1. Launchpad を開きます。
  2. メモ

    会社が Diligent One で複数のインスタンスを使用している場合は、該当するインスタンスがアクティブであることを確認します。

  3. [プロファイル]メニュー アイコン]>[プロファイル]を選択します。
  4. アプリケーション トークンの横で、[管理]をクリックします。[API トークンの管理]ページが開きます。
  5. 次のいずれかのアクションを完了します。

アクセス トークンの確認

トークンを探すには、検索、並べ替え、フィルターを使用して特定のトークンを見つけることができます。次のいずれかを実行します。

  • トークンを検索する: 検索バーにアクセストークンの最初の数文字 (最大 7 文字) を入力します。これにより、絞り込まれた結果リストが返されます。
  • トークンを並べ替える: 列見出しのいずれかをクリックすると、選択した列でトークンを昇順または降順に並べ替えることができます。
  • トークンをフィルタリングする: デフォルトでは、生成されたすべてのトークンが表示されます。ただし、トークンがロックされているか、トークンの種類 (Analytics、活動ログ、または HighBond API) によってなど、トークンのリストをサブセットにフィルタリングすることができます。利用可能なドロップダウンメニューから必要なフィルターを選択し、トークンのリストをフィルタリングします。[クリア]をクリックすると、すべてのフィルターが削除されます。

アクセストークンの説明の編集

  1. 鉛筆をクリックします。[説明]フィールドがインラインで編集可能になります。
  2. 説明を更新し、チェックマークをクリックして変更を保存します。更新された説明がテーブルに表示されます。

アクセストークンのロックまたはロック解除

トークンの削除やトークンの説明の編集を防止したい場合は、ロックすることができます。また、トークンのロックを解除して、説明を変更したり、削除を可能にすることもできます。

  • トークンの削除と説明の編集を無効にするには、トークンの横にある開いているロックをクリックします。ロックは閉じて表示され、トークンの編集や削除ができないことを示します。鉛筆とゴミ箱も消えます。
  • 閉じたロックをクリックするとロックが解除され、トークンの削除や説明の編集ができるようになります。ロックが開いて表示され、編集と削除が可能になることを示します。鉛筆とゴミ箱も再表示されます。

アクセス トークンを削除する

1 つのトークン、複数のトークンを一度に、またはリスト内のすべてのトークンを削除することができます。以前のトークンを参照用に維持する必要がない場合、トークンのリストから乱雑さを取り除くために削除することができます。ただし、トークンの削除は慎重に行うべきであり、トークンがもはやどこにも使用されていないことが確認された場合にのみ実行する必要があります。

1 つのトークンの削除

  1. トークンの横にあるゴミ箱をクリックします。# トークンを削除しますか?ダイアログボックスが表示され、削除を確認することができます。
  2. トークンを削除]をクリックします。トークンが永久に削除され、リストから削除されます。
  3. 注意

    トークンの削除は永久に行われ、元に戻すことはできません。削除されたトークンが使用中である場合、そのトークンを使用するプロセスは失敗します。トークンを誤って削除した場合、トークンを再作成し、影響を受けたアプリケーションやスクリプトに再導入する必要があります。

複数のトークンの削除

  1. 削除したいトークンの横にあるチェックボックスをクリックします。トークンのリストの上に、削除するトークンの数を示す赤いボタンが表示されます。
  2. # トークンを削除]をクリックします。# トークンを削除しますか?ダイアログボックスが表示され、削除を確認することができます。
  3. トークンを削除]をクリックします。トークンが永久に削除され、リストから削除されます。
  4. 注意

    トークンの削除は永久に行われ、元に戻すことはできません。削除されたトークンが使用中である場合、そのトークンを使用するプロセスは失敗します。トークンを誤って削除した場合、トークンを再作成し、影響を受けたアプリケーションやスクリプトに再導入する必要があります。

すべてのトークンの削除

  1. 情報アイコンの横にあるチェックボックスを選択します。これにより、リスト内のすべてのトークンが自動的に選択され、トークンのリストの上に、削除するトークンの数を示す赤いボタンが表示されます。
  2. # トークンを削除]をクリックします。# トークンを削除しますか?ダイアログボックスが表示され、削除を確認することができます。
  3. # トークンを削除]をクリックします。トークンが永久に削除され、リストから削除されます。
  4. 注意

    トークンの削除は永久に行われ、元に戻すことはできません。削除されたトークンが使用中である場合、そのトークンを使用するプロセスは失敗します。トークンを誤って削除した場合、トークンを再作成し、影響を受けたアプリケーションやスクリプトに再導入する必要があります。

期限切れトークンに対応する

トークンが削除されるか、有効期限が切れるまで、数回のリマインダーが送信されます。トークン作成者は、トークンの有効期限の 30 日前、5 日前、1 日前に通知メールを受け取ります。トークンの有効期限が切れると、通知メールも送信されます。トークンの有効期限が切れると、新しいトークンに交換しない限り、トークンに依存しているすべてのプロセスが失敗します。

有効期限切れのトークンと新しいトークンの置き換え

プロセスが失敗するのを避けるために、期限切れで失効したトークンは新しいトークンに置き換える必要があります。トークンを更新するには、新しいトークンを作成する必要があります。「アクセストークンを作成する」を参照してください。新しいトークンを作成したら、期限切れのトークンを使用しているすべてのインスタンスを探し出し、期限切れのトークンを新しく作成したトークンに置き換えます。

有効期限切れのトークンの削除

期限切れトークンを削除すると、期限切れに関する通知を受け取らなくなり、参照する必要のないトークンが削除されます。「アクセストークンを削除する」を参照してください。

注意

トークンの削除は永久に行われ、元に戻すことはできません。削除されたトークンが使用中である場合、そのトークンを使用するプロセスは失敗します。トークンを誤って削除した場合、トークンを再作成し、影響を受けたアプリケーションやスクリプトに再導入する必要があります。