TestRail の SSO 機能を利用すると、SAML 2.0、OAuth 2.0 および OpenID Connect プロトコルを使用する任意の SSO ID プロバイダー (IDP) と TestRail を統合できます。SSO 設定を有効にしたら、プロトコルを選択できます。
このガイドでは、特に Okta プロトコルの設定について説明します。まず、Okta の Web アプリケーション登録手順に従います。
-
- 管理者アカウントで Okta にサインインします。
- Admin Consoleで [Applications ] > [Applications] に移動します。(左側のパネルにあります)。
- [Create App Integration] をクリックします。
- 新規アプリケーション統合を作成します:
- Sign-on method: OIDC – OpenID Connect を選択します。
- Application type: Web Application を選択します。
- [Next] をクリックします。アプリケーションが登録され、アプリケーションの詳細の設定にリダイレクトされます。
- New Web App Integration:
- App integration name: 新しいアプリケーション統合の名前を入力します。
- Grant type: Authorization Code を選択します (このオプションは最大のセキュリティを提供します)。
- Sign-in redirect URLs (空のままではいけません) – 認証の後にリダイレクトされる URL を追加します。この URL は、OAuth および OpenID の SSO 設定ページに表示されるものと同じでなければなりません。[シングル サイン オン URL] ラベルの下の SSO 設定ページでリダイレクト URL を参照できます。
例: http://${domain}/testrail/index.php?/auth/redirect_oidc_acs - Sign-out redirect URL (オプションl): https://{domain}/index.php
- その他の任意の情報を追加し、[Save] をクリックします。
- アプリケーション統合のクライアント認証情報を取得します。
- [General] タブの [Client Credentials] セクションから [Client ID] をコピーします。
- [Client Credentials] セクションから [Client secret] をコピーします。
- [General Settings] セクションから [Okta domain] をコピーします。
- Okta の同意画面を有効にします。
- 左パネルから [Security] > [API] に移動します。
- [Default] をクリックします。
- [Scopes] タブに移動します。
- Edit OpenID: User consent – チェックをオンにして保存します。
- Profile and email: User consent を編集します – チェックをオンにして保存します。
Okta での SSO 設定 – OpenID Connect
-
- 管理者として TestRail にログインします。
- [管理] > [サイト設定] > [SSO] に移動します。
- 認証プロトコルの選択: [OpenID Connect] を選択します。
- シングル サイン オン URL: アプリケーションの新規登録時にリダイレクト URL を設定するために使用される値があらかじめ設定されています。
- 次の手順で Okta アカウントにログインしてプリケーションにアクセスし、TestRail に設定が必要な情報を取得します。
- Okta の [General] タブにある [Client Credentials] セクションから [Application (client) ID] をコピーし、TestRail の [クライアント ID] に設定します。
- Okta の [General] タブにある [Client Credentials] からクライアント シークレットの [Value] をコピーし、TestRail の [クライアント シークレット] に設定します。
- Okta の [General Settings] セクションから Okta ドメインをコピーし、URL https://${yourOktaDomain}/oauth2/default/ に当てはめて TestRail の [IDP 発行者 URL] に設定します。
- 初回ログイン時にアカウントを作成: この設定は、ユーザーが正常に認証された場合に、TestRail が新しいユーザー アカウントを自動的に作成するかどうかを指定します。
- ホワイトリスト ドメイン: 認可されていない組織からのリクエストを防ぐため、アカウントの作成を特定の電子メール ドメインだけに制限します。1 行に 1 ドメインを入力します。([ホワイトリスト ドメイン] が空の場合、デフォルトではすべてのドメインが許可されます)。
- [設定の保存] をクリックします。
Okta での SSO 設定 – OAuth 2.0
-
- 管理者として TestRail にログインします。
- [管理] > [サイト設定] > [SSO] に移動します。
- 認証プロトコルの選択: [Oauth 2.0] を選択します。
- シングル サイン オン URL: アプリケーションの新規登録時にリダイレクト URL を設定するために使用される値があらかじめ設定されています。
- 次の手順で Okta アカウントにログインしてプリケーションにアクセスし、TestRail に設定が必要な情報を取得します。
- Okta の [General] タブにある [Client Credentials] セクションから [Application (client) ID] をコピーし、TestRail の [クライアント ID] に設定します。
- Okta の [General] タブにある [Client Credentials] セクションからクライアント シークレットの [Value] をコピーし、TestRail の [クライアント シークレット] に設定します。
- Okta の [General] タブにある [General Settings] セクションから Okta ドメインをコピーし、URL https://${yourOktaDomain}/oauth2/default/v1/authorize に当てはめて TestRail の [ユーザー認可 URI] に設定します。
- Okta の [General] タブにある [General Settings] セクションから Okta ドメインをコピーし、URL https://${yourOktaDomain}/oauth2/default/v1/token に当てはめて TestRail の [アクセス トークン URI] に設定します。
- Okta の [General] タブにある [General Settings] セクションから Okta ドメインをコピーし、URLhttps://${yourOktaDomain}/oauth2/default/v1/userinfo に当てはめて TestRail の [ユーザー情報 URI] に設定します。
- 初回ログイン時にアカウントを作成: この設定は、ユーザーが正常に認証された場合に、TestRail が新しいユーザー アカウントを自動的に作成するかどうかを指定します。
- ホワイトリスト ドメイン: 認可されていない組織からのリクエストを防ぐため、アカウントの作成を特定の電子メール ドメインだけに制限します。1 行に 1 ドメインを入力します。([ホワイトリスト ドメイン] が空の場合、デフォルトではすべてのドメインが許可されます)。
- [設定の保存] をクリックします。
Okta での SSO 設定 – SAML 2.0
-
- Okta に管理者としてログインし、[Admin] > [Applications] エリアに移動します。
- [Add Application] ボタンをクリックします。
- [Create New App] ボタンをクリックして [SAML 2.0] を選択し、[Create] ボタンをクリックして確定します。
- App に名前を付けます – たとえば「TestRail」と入力し、必要に応じてロゴをアップロードします。
- [Next] ボタンをクリックします。
- TestRail にログインし、[管理] > [サイト設定] コンソールの [SSO] ページに移動します。
- TestRail の SSO 設定ページから [エンティティ ID] をコピーして Okta の [Audience URL (SP Entity ID)] フィールドに貼り付けます。
- TestRail の SSO 設定ページから [シングル サイン オン URL] をコピーして Okta の [Single sign on URL] フィールドに貼り付けます。
- Okta の [Use this for Recipient URL and Destination URL] チェックボックスはオンのままにします。
- [Name ID format] および [Application Username] フィールドは無視してかまいません。
- Okta の属性ステートメントを次のように設定します。
属性名 属性値 FirstName user.firstName LastName user.lastName Email user.email 上の値は大文字/小文字が区別されます。
- Okta で [Next] ボタンをクリックし、必要に応じて質問や他のフィールドに記入します。
- 終了するか、または Okta の [Sign On] タブで、[View Setup Instructions] ボタンをクリックして、TestRail に必要な URL と証明書を表示します。
- Okta の [Identity Provider Single Sign-On URL] および [Identity Provider Issuer URL] の値をコピーし、TestRail の [IDP SSO URL] および [IDP 発行者 URL] フィールドに設定します。
- Okta から X.509 証明書をコピーして TestRail に貼り付けます (または証明書をダウンロードしてアップロードします)。
- [保存] をクリックします。接続をテストして設定を確認します。
- TestRail の設定を行っている管理者が Okta で作成した App に割り当てられていれば、接続テストは成功するはずです。これでシングルサインオン (SSO) モードで TestRail を使用する準備が整いました。