メインコンテンツへスキップ

Personal API tokens

Personal API tokens を使用すると、インタラクティブなログインセッションを使わずに、DoiT API へプログラムから認証できます。各トークンには、利用可能な権限の一部のみを割り当てるためのスコープと、任意指定の有効期限を設定できるため、請求データのエクスポート、Cloud Analytics（クラウド分析）レポートの取得、社内スクリプトからの DoiT API リクエストの自動化などのワークフローに対して、限定的なアクセス権を付与できます。

ユーザーページの API タブから、Personal API tokens を作成および管理します。

Required permission​

特別な権限は不要です。認証済みのユーザーであれば、誰でも自分の Personal API tokens を作成・表示・無効化・有効化・削除できます。詳しくは、Service account and API token permissions を参照してください。

Create an API token​

API トークンは最大 10 個まで作成できます。新しく作成したトークンが有効になるまで、最大 1 分程度かかる場合があります。

  1. API タブで Create API token を選択してください。

  2. Create API token で、次の項目を入力・設定してください。

    • Token name: トークンのわかりやすい名前を入力してください。

    • (任意) Expiry date: トークンが無効になる日付を選択してください。この項目を空欄のままにした場合、トークンの有効期限は設定されません。

    • Permission scope: トークンに付与するアクセスレベルを選択してください。トークンの権限は、ユーザーのロールで利用可能な権限の範囲に制限されます。次のいずれかの権限スコープを選択してください。

      Scope説明
      Read only読み取り専用の権限のみを付与します。変更を行う必要がない監視やレポート用途の連携に使用してください。
      Full accessユーザーのロールで利用可能なすべての権限を付与します。
      Custom scope個別の権限を選択できます。Search フィールドを使用して、名前または説明で権限をフィルタリングしてください。少なくとも 1 つの権限を選択する必要があります。

      Create API token ダイアログに表示される 3 つの permission scope タブ

  3. Create token を選択してください。

  4. トークンをすぐにコピーするかダウンロードしてください。トークン値は一度しか表示されず、後から再取得することはできません。

  5. Done を選択してダイアログを閉じてください。

注意

API トークンは、他のパスワードと同様に厳重に管理してください。トークンを共有したり、ソースコード管理にコミットしたりしないでください。ダイアログを閉じると、トークン値には再度アクセスできません。

API トークンの使用方法については、DoiT Developer Hub: Get started を参照してください。

Manage API tokens​

View API tokens​

トークン一覧には、各トークンについて次の情報が表示されます。

列説明
Tokenトークン名、権限スコープ、権限数、およびマスクされたキー。
Status現在の状態。Active、Disabled、Expired のいずれかです。
Createdトークンが作成された日付。
Expires作成時に有効期限が設定されている場合、その日付。
Last usedトークンが最後に API リクエストに使用された日付。

テーブル上部のサマリー行には、保有しているトークンの総数、今後 30 日以内に期限切れとなるトークンの数、60 日以上使用されていないトークンの数が表示されます。

View token permissions​

トークンに割り当てられている権限の一覧を表示するには、トークン行の権限数リンク（例: 「5 permissions」）を選択してください。選択すると、各権限の名前と説明が表示されるダイアログが開きます。

権限ダイアログには、トークンに「選択された権限」と「有効な権限」が表示されます。トークン作成後にユーザーのロール権限が変更された場合、トークンの有効な権限が当初の指定よりも狭くなることがあります。この場合、一部の権限が利用できなくなっている旨の警告が表示されます。

Filter API tokens​

フィルターバーを使用して、トークン一覧を検索およびフィルタリングできます。期限切れトークンも一覧に含めるには、Show expired tokens を有効にしてください。

Token lifecycle statuses​

各トークンには、次のいずれかのライフサイクルステータスがあります。

  • Active: トークンが有効であり、API リクエストに使用できます。

  • Disabled: トークンが一時的に無効化されています。

  • Expired: トークンが有効期限を過ぎており、使用できません。

Disable or enable a token​

トークンを無効化すると、削除せずに一時的にアクセス権を取り消すことができます。

  1. トークン行の三点リーダーメニューを選択してください。

  2. Disable token を選択してください。

無効化したトークンを再度有効化するには、同じメニューから Enable token を選択してください。再有効化後、そのトークンを使用したリクエストは再び成功するようになります。

Delete a token​

トークンを削除すると、そのトークンは完全に削除され、元に戻すことはできません。そのトークンを使用しているアプリケーションやスクリプトは、以後認証できなくなります。

  1. トークン行の三点リーダーメニューを選択してください。

  2. Delete token を選択してください。

  3. Delete this token? で、トークンの削除を確定するために DELETE と入力してください。

Legacy API tokens​

レガシー API トークン（ユーザープロファイルに紐づいた Personal API token で、ユーザーのロールによって付与された権限セット全体にアクセス可能）を引き続き使用することもできます。レガシートークンは、取り消されるまで有効です。次の場合、レガシートークンは自動的に取り消されます。

  • ロールまたは権限が変更された場合: API 認証経路は、実際のシステムアクセスと動的に同期します。ロールがダウングレードされた場合、トークンの権限も即座に縮小されます。

  • アカウントが無効化された場合: ユーザープロファイルを無効化すると、関連するすべてのレガシー認証情報が自動的に失効します。

  • 手動でトークンを削除した場合。

ただし、新しいレガシートークンの作成は非推奨です。今後は、このページでスコープ付き Personal API token を作成するか、service account API token を作成する必要があります。既存の連携は、Personal API tokens または Service accounts への移行を計画してください。

Migrate a legacy token to a service account​

  1. その連携が実際に必要としている権限を特定してください。レガシートークンは、それを作成したユーザーのロール全体を継承しており、必要以上に広い権限を持っていることがよくあります。

  2. 必要な権限のみを持つ Service account を作成してください。詳しくは、Create a service account を参照してください。

  3. Service account の API tokens タブでトークンを作成し、それをシークレットマネージャーまたは CI/CD ストアに保存し、連携が Authorization: Bearer <token> を送信するよう更新してください。

  4. 元のユーザーの ユーザーページの API タブから、レガシートークンを取り消してください。レガシーキーを削除すると即座に反映され、そのキーを使用し続けている呼び出し元は認証エラーを受け取ります。

Migrate a legacy token to a personal API token​

自動化処理を特定のユーザーに紐づけたままにする必要がある場合は、Service account の代わりに、適切なスコープを持つ 1 つ以上の Personal API tokens を作成してください。手順は同様です。新しいトークンを作成し、呼び出し元を更新して動作を確認してから、API タブでレガシーキーを削除してください。

参照
に最終更新