ツイートシェアはてブ LINE Pocket

OAuth 2.0 認証モジュール

OAuth 2.0 認証モジュールを使用すると、ユーザーは外部認証サービスに保存されている資格情報を使用して YouTrack にログインできます。YouTrack は、Amazon、Azure AD 2.0、Bitbucket クラウド、Facebook、GitLab、Keycloak、マイクロソフトライブ、オクタ、PayPal、ヤンデックスパスポート用に事前構成された認証モジュールを提供します。

汎用 OAuth 2.0 認証モジュールを使用して、Basecamp、Stack Exchange、Zendesk など、OAuth 2.0 をサポートする他のサードパーティサービスのアカウントでユーザーが YouTrack にログインできるようにします。

YouTrack で OAuth 2.0 認証モジュールを有効にする場合:

ユーザーは、外部サービスで使用する資格情報を使用して YouTrack にログインします。
YouTrack ユーザーは覚えるべきより少ないアカウントとパスワードを持っています。
接続されたサービスにアカウントを持つ新しいユーザーは、YouTrack で独自のアカウントを作成できます。

OAuth 2.0 認証を有効にする

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

この手順は 3 つのステップで行われます。

YouTrack でリダイレクト URI を生成します。認証モジュールを作成すると、YouTrack は認証サービスで使用するためのリダイレクト URI を生成します。この URI は各ログイン要求の送信元を識別します。
許可サービスでクライアント ID とシークレットを生成します。YouTrack から送信されるすべてのログイン要求には、一意の識別子が含まれます。認証モジュールに保存した ID とシークレットは、各ログインリクエストが承認されることを承認サービスに伝えます。
YouTrack で認証モジュールを有効にします。YouTrack が許可サービスでの認証に使用する情報を生成したら、値を YouTrack にコピーしてモジュールを有効にします。

YouTrack でリダイレクト URI を生成する

OAuth 2.0 認証モジュールを作成すると、YouTrack は許可サービスで使用するリダイレクト URI を生成します。

YouTrack でリダイレクト URI を生成するには:

管理メニューから、アクセス管理> 認証モジュールを選択します。
新規モジュールドロップダウンリストから、OAuth 2.0 を選択します
- 新しい OAuth 2.0 モジュールダイアログが開きます。
名前および認証 URL を入力してから、作成ボタンをクリックします。
- Auth モジュールページには、新しい OAuth 2.0 認証モジュールの設定が表示されます。
- YouTrack は、承認サービスで使用するためのリダイレクト URI を生成します。
この機能がご使用のブラウザーでサポートされている場合は、コピーボタンを使用してリダイレクト URI をクリップボードにコピーしてください。

承認サービスでクライアント ID とシークレットを生成する

次のステップは、YouTrack の許可されたリダイレクト URI を許可サービスに登録することです。このプロセスはサービスによって異なります。Amazon、Azure AD 2.0、Bitbucket クラウド、Facebook、GitLab、マイクロソフトライブ、PayPal、ヤンデックスパスポートなど、事前構成された OAuth 2.0 認証モジュールのセットアップ手順を参照できます。他のサードパーティ認証サービスの手順は似ています。

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

セットアップを完了するには、OAuth 2.0 auth モジュールに認証サービスからのクライアント ID とシークレットを保存します。

許可サービスからクライアント ID をコピーし、YouTrack のクライアント ID 入力フィールドに貼り付けます。
認可サービスからクライアントシークレットをコピーし、YouTrack のクライアントシークレット入力フィールドに貼り付けます。
認証モジュールのオプション設定を構成します。詳しくは、追加設定を参照してください。
モジュールを有効にするボタンをクリックしてください。
- OAuth 2.0 認証モジュールが有効になっています。
- ボタンイメージ設定に保存されているアイコンがログインダイアログウィンドウに追加されます。ユーザーは、このアイコンをクリックして、接続された許可サービスのアカウントで YouTrack にログインできます。

設定

設定ページの最初のセクションには、認証モジュールの一般設定が表示されます。ここには、YouTrack を許可サービスに登録するために使用するリダイレクト URI、および許可サービスで生成されたクライアント ID とクライアントシークレットを保管する入力フィールドもあります。

設定	説明
タイプ	YouTrack のサードパーティー認証が有効になっている認証サービスの種類を表示します。
名前	認証モジュールの名前を格納します。この設定を使用して、このモジュールを Auth モジュールリスト内の他の認証モジュールと区別します。
ボタンイメージ	接続されている認証サービスで、自分のアカウントで YouTrack にログインするためにユーザーがクリックするボタンに使用されるイメージを表示します。JPG、GIF、PNG ファイルをアップロードできます。イメージは自動的に 48 x 48 ピクセルにサイズ変更されます。
リダイレクト URI	認証サービスで YouTrack への接続を登録するために使用される認証済みリダイレクト URI を表示します。
クライアント ID	認可サービスがログイン要求を検証するために使用する識別子を格納します。Web アプリケーションの認証設定を構成して認証済みリダイレクト URI を入力すると、認証サービスでこの値が生成されます。
クライアントシークレット	クライアント ID を検証するために使用されるシークレットまたはパスワードを保管します。この値は、認証サービスでクライアント ID と一緒に生成します。
拡張グラント	拡張許可に使用されるときに認証モジュールを識別するために使用される値を保存します。値が指定されている場合、YouTrack は、承認サービスによって発行されたアクセストークンを、YouTrack へのアクセスを許可するトークンと交換する要求を処理します。アクセストークンを正常に交換するには、認証モジュールがサードパーティの認証サービスで承認され、YouTrack で有効になっている必要があります。 Hub REST API を使用してアクセストークンを交換する方法については、拡張グラントを参照してください。

認可サービスのエンドポイント

ページのこのセクションの設定には、承認サービスで使用される OAuth 2.0 エンドポイントが格納されます。追加の設定により、要求の範囲を定義し、サービスで認証する方法を選択できます。

事前設定された OAuth 2.0 モジュールの場合、選択された許可サービスによって使用される値は自動的に設定されます。

設定	説明
許可	YouTrack がユーザーエージェントリダイレクトを介してリソース所有者から承認を得るために使用するエンドポイントを格納します。
トークン	YouTrack がアクセス権と認可付与を交換するために使用するエンドポイントを格納します。
ユーザーデータ	認証されたユーザーのプロファイルデータを見つけるために使用されるエンドポイントを格納します。
メール	認証されたユーザーのメールアドレスを見つけるために使用されるエンドポイント。メールアドレスがユーザープロファイルに保存されていない場合にのみ使用してください。
アバター	認証されたユーザーのアバターとして使用されるバイナリファイルを見つけるために使用されるエンドポイント。アバターがユーザープロファイルに直接保存されていない場合にのみ使用してください。

フィールドマッピング

ユーザープロファイル応答オブジェクトが許可サービスによって返されると、指定されたフィールドパスからの値が、YouTrack に保管されているアカウントにコピーされます。次の設定を使用して、認証されたユーザーのプロファイルデータを検索するエンドポイントを定義し、認証サービスに格納されているフィールドを対応する YouTrack アカウントにマップします。

事前設定された OAuth 2.0 モジュールの場合、選択された許可サービスによって使用される値は自動的に設定されます。

ネストされたオブジェクト内のフィールドへのパスを指定するには、スラッシュ文字（/）で区切られた一連のセグメントを入力します。
複数の場所に格納されている値を参照するには、「エルビス演算子」(?:) を複数のパスの区切り文字として使用します。このオプションを使用すると、YouTrack は、指定されたフィールドで最初に検出した空でない値を使用します。

フィールド	説明
ユーザー ID	YouTrack アカウントのユーザー ID プロパティにコピーする値を格納するフィールドにマップします。
ユーザー名	YouTrack アカウントのユーザー名フィールドにコピーする値を格納するフィールドにマップします。このオプションは、YouTrack バージョン 2023.1.65369 以降で使用できます。
フルネーム	YouTrack アカウントのフルネームフィールドにコピーする値を格納するフィールドにマップします。
メール	YouTrack アカウントのメールフィールドにコピーする値を格納するフィールドにマップします。
メール確認状態	YouTrack アカウントの確認済みメールプロパティにコピーする値を格納するフィールドにマップします。
アバター	YouTrack アカウントでアバターとして使用するイメージを格納するフィールドにマップします。
イメージの URL パターン	ID によって参照されるアバターのイメージ URL を生成します。使用 <picture-id> アバターを格納するフィールドを参照するためのプレースホルダー。
グループ	接続された承認サービスでグループメンバーシップの割り当てを格納する属性にマップします。この値を指定すると、許可サービスのグループメンバーシップを YouTrack の対応するグループとマップおよび同期できます。詳細については、グループマッピングを参照してください。

追加設定

次のオプションは、ページの下部にあります。これらの設定により、リクエストスコープを定義し、サービスでの認証方法を選択できます。

このセクションの他のオプションを使用すると、アカウントの作成とグループメンバーシップを管理し、アイドル状態の接続によって消費される処理リソースの損失を減らすことができます。

オプション	説明
スコープ	アクセス要求の範囲を設定します。スコープのリストをスペースで区切って入力します。
認証	資格情報を許可サービスに渡す方法を決定します。
ユーザー作成	接続された許可サービスに保管されているアカウントでログインしている未登録ユーザー用の YouTrack アカウントの作成を可能にします。YouTrack はユーザーに既存のアカウントがあるかどうかを判断するためにメールアドレスを使用します。
メールの自動確認	認証サービスがこの属性の値を返さない場合に、YouTrack がメールアドレスの検証ステータスを設定する方法を決定します。
自動参加グループ	接続された承認サービスに保存されているアカウントでログインするときに、ユーザーをグループに追加します。1 つまたは複数のグループを選択できます。グループに自動参加する新しいユーザーは、このグループに割り当てられたすべての権限を継承します。少なくとも 1 つのグループにユーザーを追加することをお勧めします。それ以外の場合、新しいユーザーには、現在すべてのユーザーグループに割り当てられているアクセス許可のみが付与されます。
接続タイムアウト	承認サービスへの接続を確立するために待機する期間を設定します。デフォルト設定は 5000 ミリ秒（5 秒）です。
読み取りタイムアウト	承認サービスからユーザープロファイルデータを読み取って取得するのを待機する期間を設定します。デフォルト設定は 5000 ミリ秒（5 秒）です。
監査	YouTrack のイベントの監査ページへのリンク。そこで、この認証モジュールに適用された変更のリストを表示できます。

グループマッピング

グループマッピングタブで、承認サービスの既存のグループを YouTrack のグループにマップできます。

OAuth 2.0 サービスのグループを YouTrack のグループにマップする場合は、この認証モジュールの設定の属性マッピングセクションで、OAuth2.0 サービスのグループメンバーシップを格納するグループ属性を指定する必要があります。

グループマッピングが構成されている場合、YouTrack は、ユーザーがディレクトリサービスで管理されているアカウントでログインするときに、グループメンバーシップをチェックします。YouTrack は、YouTrack グループにマップされている OAuth2.0 サービスの各グループに対して次の操作を実行します。

マップされた OAuth2.0 グループのメンバーであり、マップされた YouTrack グループのメンバーではないユーザーは、YouTrack のグループに追加されます。
マップされた OAuth2.0 グループのメンバーではなく、マップされた YouTrack グループのメンバーであるユーザーは、YouTrack のグループから削除されます。

承認サービスのグループメンバーシップへの変更は、ユーザーが OAuth2.0 サービスから自分のアカウントを使用してログインした場合にのみ YouTrack に適用されます。

YouTrack では、複数の OAuth2.0 グループを単一のターゲットグループにマッピングできます。OAuth2.0 グループを複数の YouTrack グループにマッピングすることはできません。