YouTrack サーバー 2024.2 ヘルプ

永久トークンの管理

YouTrack サーバーでは、永久トークンにより、開発者は OAuth 2.0 認証フローを実装しなくても、スクリプトとアプリケーションで RESTAPI 呼び出しを使用して安全に操作にアクセスして実行できます。永久トークンは、ユーザーアカウントに付与されたアクセス許可を持つサービスへのアクセスを許可します。

このページでは、ユーザープロファイルで実行される永久トークンを使用した操作について説明します。永久トークンを使用した RESTAPI 呼び出しのサンプルについては、永久トークン認証を参照してください。

永久トークンを作成する

ユーザーアカウントに付与されているアクセス許可を使用してプログラムでサービスにアクセスするには、独自の永久トークンを作成します。

ここにリストされている権限に加えて、トークンを使用してアクセスするサービスを読み取るための権限が必要です。接続されたサービスへのアクセスは Hub で管理されます。YouTrack クラウドまたは組み込みの Hub サービスを使用する YouTrack サーバーのインストールを使用している場合、すべてのユーザーが YouTrack サービスにアクセスできます。

YouTrack サーバーのインストールで外部 Hub サービスを使用する場合、接続されたサービスを読み取るためのアクセス許可は 2 つの方法で付与されます。

  • サービスのアクセス設定により、グループメンバーはサービスメニューからアプリケーションにアクセスできます。この方法でアクセスが許可されているグループのメンバーである場合、サービスにアクセスするための永続的なトークンを作成できます。基本的に、サービスメニューにサービスの名前とアイコンが表示されている場合、サービスにアクセスするためのトークンを生成できます。

  • 低レベルの管理者読み取り権限が付与されます。

ログインしていてトークンを作成するオプションが表示されない場合は、管理者に低レベルの管理者読み取り権限をアカウントに付与するか、サービスが表示されているグループに追加するよう依頼してください。

新しい永久トークンを生成するには:

  1. アプリケーションヘッダーでアバターをクリックし、メニューからプロファイルを選択します。

  2. アカウントのセキュリティタブに切り替えます。

  3. 新規トークンボタンをクリックしてください。

  4. 新しい永久トークンダイアログで、新しいトークンの名前とそのアクセス範囲を指定します。トークンの有効範囲は、この新しいトークンでアクセスできるサービスのリストです。

    New permanent token dialog

    組み込みの Hub サービスを使用する YouTrack インストールには、YouTrackYouTrack の管理に対して別々のスコープがあります。

    • YouTrack スコープは、YouTrack の課題、タグ、コマンド、アジャイルボード、ダッシュボード、レポート、その他の基本的な操作を操作するためのアクセス許可を付与します。

    • YouTrack の管理スコープは、プロジェクトの操作、ユーザーアクセスの管理、サーバー設定の更新を行うためのアクセス許可を付与します。

    これらのスコープを使用すると、RESTAPI 呼び出しを次のエンドポイントに送信することもできます。

    スコープ

    URL

    説明

    YouTrack

    /rest/...

    /api/...

    課題、タグ、コマンド、アジャイルボード、ダッシュボード、レポートなど、YouTrack のエンドユーザー部分に API リクエストを送信します。

    YouTrack の管理

    /hub/api/...

    /hub/rest/...

    YouTrack の管理部にプロジェクトリクエストとアクセス管理、サーバー設定などの API リクエストを送信します。

  5. トークンを作成ボタンをクリックしてください。

    • 新しいトークンを含むダイアログウィンドウが表示されます。

    Permanent token created
  6. トークンをコピーするには、次の 2 つのアクションのいずれかを使用します。

    • トークンをコピーボタンをクリックしてください。

    • ポインターでトークンを選択し、オペレーティングシステムの標準キーボードショートカットを使用して、現在の選択をクリップボードにコピーします。

  7. トークンをコピーしたら、ダイアログを閉じます。

    • 新しいトークンはユーザーアカウントに関連付けられ、永久トークンリストに表示されます。

    Permanent token list

永久トークンを削除する

永久トークンには有効期限はありません。認証されたサービスが侵害された疑いがある場合は、プロファイル内のこのトークンを明示的に削除できます。

永久トークンを削除するには

  1. アプリケーションヘッダーでアバターをクリックし、メニューからプロファイルを選択します。

  2. アカウントのセキュリティタブに切り替えます。

  3. トークンのリストで、取り消したいトークンを選択します。

  4. 削除ボタンをクリックしてください。

    • 確認ダイアログが表示されます。

  5. 削除ボタンをクリックして操作を確定します。

    Delete token confirm
    • 選択した永久トークンが削除され、リストから削除されます。