YouTrack サーバー 2024.2 ヘルプ

GitHub 認証モジュール

この認証モジュールにより、ユーザーは GitHub 資格情報を使用して YouTrack にログインできます。

GitHub 認証を有効にする

既存の GitHub アカウントを持つユーザーが YouTrack にログインできるようにするには、GitHub 認証モジュールを有効にします。

この手順は次の手順で実行します。

  1. YouTrack でコールバック URL を生成します。GitHub の認証モジュールを作成すると、YouTrack はこのサービスで使用するコールバック URL を生成します。この URL は、GitHub への各ログインリクエストのソースを識別します。

  2. GitHub でクライアント ID とシークレットを生成します。YouTrack から GitHub に送信されるすべてのログインリクエストには、一意の識別子が含まれています。認証モジュールに保存した ID とシークレットは、各ログインリクエストが承認されていることを GitHub に伝えます。

  3. YouTrack で認証モジュールを有効にします。YouTrack が GitHub での認証に使用する情報を生成したら、値を YouTrack にコピーしてモジュールを有効にします。

  4. GitHub OAuth アプリケーションを承認します。これにより、OAuth アプリケーションに、ログイン要求の認証に必要な情報を読み取るためのアクセスが許可されます。この手順は、GitHub の組織に属するアカウントを使用する場合、または許可された組織を使用して特定の組織に属するユーザーにログインを制限する場合にのみ必要です。

YouTrack でコールバック URL を生成する

開始するには、YouTrack を開き、GitHub アカウントの認証モジュールを作成します。認証モジュールを作成すると、YouTrack は許可サービスで使用するコールバック URL を生成します。

YouTrack でコールバック URL を生成するには:

  1. 管理メニューから、アクセス管理> 認証モジュールを選択します。

  2. 新規モジュールドロップダウンリストから GitHub を選択します。

    • Auth モジュールページには、新しい GitHub 認証モジュールの設定が表示されます。

    • YouTrack は、GitHub で使用するためのコールバック URL を生成します。

    Auth module github settings

  3. ページの指示に従ってコールバック URL をコピーします。

  4. リンクをクリックして、GitHub の新しい OAth アプリケーションページにアクセスします。

GitHub でクライアント ID とシークレットを生成する

  1. GitHub アカウントにログインします。

  2. 一般的なパラメーターを指定して、新しい OAuth アプリケーションを登録します: 名前、ホームページ URL、オプションのアプリケーションの説明。

  3. 認証コールバック URL で、YouTrack の認証モジュールページからコピーしたコールバック URL を貼り付けます。

  4. アプリケーション登録ボタンをクリックしてください。

    • GitHub は、YouTrack モジュールのセットアップに必要な資格情報を生成し、ページの上部に表示します。

YouTrack で認証モジュールを有効にする

  1. GitHub からクライアント ID をコピーし、YouTrack のクライアント ID 入力フィールドに貼り付けます。

  2. GitHub からクライアントシークレットをコピーし、YouTrack のクライアントシークレット入力フィールドに貼り付けます。

  3. 認証モジュールのオプション設定を構成します。詳しくは、設定を参照してください。

  4. モジュールを有効にするボタンをクリックしてください。

    • GitHub 認証モジュールが有効になっています。

    • ボタンイメージ設定に保存されているアイコンがログインダイアログウィンドウに追加されます。ユーザーはこのアイコンをクリックして、GitHub アカウントで認証できます。

    Login dialog with GitHub

GitHub OAuth アプリケーションを承認する

GitHub 認証モジュールを使用して初めてログインしようとすると、GitHub の OAuth アプリケーションへのアクセスを承認するように求められます。

Prompt to authorize the GitHub OAuth application.

この時点でアプリケーションにアクセスを許可できない場合は、組織の設定からアクセスを許可できます。具体的な手順については、GitHub のドキュメント(英語)を参照してください。

設定

フィールド

説明

タイプ

Hub でサードパーティー認証が有効になっているアプリケーションまたはサービスの名前を表示します。

名前

認証モジュールの名前を格納します。この設定を使用して、このモジュールを Auth モジュールリスト内の他の認証モジュールと区別します。

ボタンイメージ

ユーザーが GitHub アカウントで YouTrack にログインするためにクリックするボタンに使用されるイメージを表示します。

認証コールバック URL

GitHub で YouTrack への接続を登録するために使用される認証コールバック URL を表示します。

クライアント ID

ログインリクエストを検証するために GitHub が使用する識別子を格納します。アプリケーションの認証設定を構成し、コールバック URL を入力すると、GitHub でこの値を生成します。

クライアントシークレット

クライアント ID の検証に使用されるシークレットまたはパスワードを保存します。この値は、クライアント ID とともに GitHub で生成します。

サーバー URL

ユーザーが GitHub アカウントでログインしたときに、YouTrack がログイン要求を送信するサーバーの URL を表示します。

スコープ

アクセス要求のスコープを表示します。

このフィールドに表示される情報は、認証モジュールの構成に役立ちます。

許可された組織

この認証モジュールのログインを GitHub の特定の組織に属するユーザーに制限します。組織のコンマ区切りリストを入力します。空の場合、GitHub アカウントを持つユーザーはこの認証モジュールを使用してログインできます。

追加設定

以下のオプションはページの下部にあります。これらの設定を使用して、YouTrack アカウントの作成とグループメンバーシップを管理し、アイドル接続によって消費される処理リソースの損失を減らします。

オプション

説明

ユーザー作成

接続されている認証サービスに保存されているアカウントでログインしている未登録ユーザーの Hub アカウントの作成を有効にします。YouTrack はメールアドレスを使用して、ユーザーが既存のアカウントを持っているかどうかを判断します。

自動参加グループ

接続された承認サービスに保存されているアカウントでログインするときに、ユーザーをグループに追加します。1 つまたは複数のグループを選択できます。グループに自動参加する新しいユーザーは、このグループに割り当てられたすべての権限を継承します。

少なくとも 1 つのグループにユーザーを追加することをお勧めします。それ以外の場合、新しいユーザーには、現在すべてのユーザーグループに割り当てられているアクセス許可のみが付与されます。

接続タイムアウト

承認サービスへの接続を確立するために待機する期間を設定します。デフォルト設定は 5000 ミリ秒（5 秒）です。

読み取りタイムアウト

承認サービスからユーザープロファイルデータを読み取って取得するのを待機する期間を設定します。デフォルト設定は 5000 ミリ秒（5 秒）です。

監査

YouTrack のイベントの監査ページへのリンク。そこで、この認証モジュールに適用された変更のリストを表示できます。

Facebook 認証モジュール GitLab 認証モジュール