コンテンツにスキップ

OIDC


ここでは、Guanceワークスペースで OIDC/OAuth 2.0 プロトコルに基づくシングルサインオン(SSO)を設定する方法について説明します。

Guanceでは、次の 2 種類の OIDC 設定方法をサポートしています。

標準 OIDC 設定:OpenID Connect 標準に準拠したアイデンティティプロバイダー(IdP)向け

非標準 OIDC 設定:OAuth 2.0 ベースだが API 仕様が標準と異なる IdP 向け

事前準備

設定を開始する前に、以下をご準備ください。

準備項目 説明
IdP 管理者権限 企業の IdP(Keycloak、Authing、Auth0、自前の OIDC サービスなど)でアプリケーションを作成する必要があります
クライアント認証情報 IdP から取得した Client ID と Client Secret
サービスディスカバリ URL IdP の Issuer URL(例:https://****.example.com)
企業メールのドメイン SSO ユーザーのメールアドレス識別に使用するドメインのサフィックス(例:example.com)

標準 OIDC 設定

手順 1:設定ページを開く

  1. 管理 > メンバー管理 > SSO 管理 > ユーザー SSO に移動します。
  2. OIDC アクセスタイプを選択します。
  3. IdP を追加 をクリックします。

手順 2:接続設定

  1. IdP 名:ID 管理サービスを提供するプラットフォーム名。❗️この名称は IdP エイリアスとして SSO の IdP 選択画面に表示されるため、目的の IdP をすばやく見つけられるよう適切な名称を入力してください。
  2. 備考:IdP に関する説明を記録するために、ユーザーが任意で追加できる説明情報。
  3. IdP URL:IdP の完全な URL。サービスディスカバリ URL としても使用されます。例:https://guance.example.com
  4. クライアント ID:認証サービスから提供される、クライアントアプリケーションを識別するための一意の識別子。
  5. クライアントシークレット:クライアント ID と組み合わせて、クライアントアプリケーションの認証に使用します。
  6. 認可リクエストのスコープ:認可リクエストの範囲。デフォルトでは openid、profile、email が含まれ、必要に応じて address と phone クレームを追加できます。

手順 3:マッピング設定

SSO ログインを実現するには、IdP のアカウント情報と Guance のアカウント情報をフィールドマッピングする必要があります。主なフィールドは次のとおりです。

  1. ユーザー名:必須。IdP の「ユーザー名」フィールド(例:referred_username)。
  2. メール:必須。IdP の「メール」フィールド(例:email)。
  3. 電話番号:任意。IdP の「電話番号」フィールド(例:phone)。

手順 4:ログイン制御

  1. アクセス制限:ログインに使用するメールアドレスのドメインサフィックスが、設定したドメインと一致するかを検証します。一致するメールアドレスのみが SSO ログインリンクにアクセスできます。ユーザーは初回ログイン時に Guance のメンバーアカウントを動的に作成できるため、事前にワークスペース内で作成しておく必要はありません。
  2. ロール認可:初回ログインする SSO アカウントにロールを割り当てます。2 回目以降にログインするアカウントには影響しません。
  3. ワークスペースで SAML マッピング が有効になっている場合は、マッピングルールに従ってロールが優先的に割り当てられます。
  4. セッション保持:SSO ログインセッションの無操作保持時間と最大保持時間を設定します。

セッション保持設定

設定項目 範囲 デフォルト値 説明
無操作ログインセッション保持 180~1440 分 180 分 ユーザーが操作しない状態が続いた場合に自動的にログアウトされるまでの時間
ログインセッション最大保持 0~7 日 7 日 操作の有無にかかわらず、この時間に達すると強制的にログアウトされます。0 はタイムアウトなしを意味します

セッション保持時間を変更した場合、ログイン済みのメンバーには従来の設定が維持され、新規にログインするメンバーには最新の設定が適用されます。

ロール認可とロールマッピングの関係

  • ワークスペースで OIDC ロールマッピング が無効の場合:初回ログインするすべての SSO ユーザーに、ここで設定したデフォルトロールが割り当てられます。
  • ワークスペースで OIDC ロールマッピング が有効の場合:マッピングルールに従ってロールが優先的に割り当てられ、ルールに一致しないユーザーにはここで設定したデフォルトロールが割り当てられます。

IdP 側の OIDC 設定に関する注意事項

  • 認可モード:authorization_code 認可モードのみサポートしています。戻り値の型は code である必要があります。

  • id_token の署名アルゴリズム:現時点では HS256 のみサポートしています。

  • code を token に交換する際のクライアント認証方式:

  • デフォルトでサポート:client_secret_basic

  • カスタム設定でサポート:client_secret_post、client_secret_basic、none

  • scope の範囲:

  • デフォルトのスコープ:openid、profile、email、phone

  • カスタム設定の要件:openid を必ず含める必要があります。その他はカスタマイズ可能ですが、返される結果には email を必ず含め、phone_number は任意で返すことができます。

手順 5:コールバック URL を取得する

IdP の作成が完了したら、編集ボタンをクリックして以下の URL を取得し、IdP に提供します。

  1. コールバック URL:IdP での認可成功後に Guance へリダイレクトするための URL。
  2. ログイン開始 URL:Guance の SSO ログインエントリポイントの URL。

手順 6:IdP でコールバックアドレスを設定する

手順 5 で取得したコールバック URL を使用して、IdP 側で以下の設定を行います。

  1. コールバックアドレス(Redirect URI):Guance から提供されたコールバック URL を入力します。
  2. 認可モード:authorization_code をサポートしていることを確認します。
  3. 戻り値の型:code をサポートしていることを確認します。

非標準 OIDC 設定

OAuth 2.0 ベースであるものの、標準の OIDC 仕様に準拠していない IdP に適用します。主に以下のケースが該当します。

  • IdP が標準の OIDC ディスカバリエンドポイント(.well-known/openid-configuration)を提供していない。
  • ユーザー情報を取得する API のパスまたは戻り値の形式が標準の OIDC と異なる。
  • API パラメータの大文字小文字の表記が標準と一致しない。

設定手順

  1. 管理 > メンバー管理 > SSO 管理 > OIDC > IdP を作成 に移動します。
  2. 右上隅の切り替えをクリックすると、標準の OIDC 設定ページに切り替えられます。
  3. 接続設定:

  4. IdP 名:表示名をカスタマイズできます(64 文字以内)

  5. 設定ファイルのアップロード:テンプレートをダウンロードし、認可エンドポイント、Token エンドポイント、ユーザー情報エンドポイント、フィールドマッピングなどの情報を記入してアップロードします
  6. 備考:IdP に関する説明を記録するために、ユーザーが任意で追加できる説明情報

  7. ログイン設定:標準の OIDC と同じ設定(アクセス制限、ロール認可、セッション保持)。

  8. 保存して有効にします。

ログイン検証

  1. SSO ログインページ を開き、完全な企業メールアドレスを入力します。
  2. アカウントに対応する IdP を選択し、企業認証ページの案内に従ってログインを完了します。
  3. 認証が成功すると、ワークスペース選択ページでアクセス権のあるワークスペースに入ります。

既存の SSO アカウントは、完全なメールアドレスに対応する SSO アイデンティティから IdP を検索します。SSO アイデンティティがまだ作成されていない場合は、アクセス制限に基づいてメールアドレスまたはドメインで照合されます。詳細なルールはユーザーログインを参照してください。

注意事項

  1. ロールマッピングが有効な場合:ユーザーがいずれのロールマッピングルールにも一致しない場合、またはロールマッピングが無効になっている場合は、ログイン後に「アクセス権がありません」と表示されます。
  2. IdP を削除した場合:ユーザーは SSO でログインしても、削除した IdP に対応するワークスペースが表示されません。
  3. 複数 IdP の設定:1 つのワークスペースで最大 10 個の IdP をサポートしています。ユーザーはアカウントに一致する利用可能な IdP で企業認証を完了した後、ワークスペースのアクセス権限に基づいてアクセスします。
  4. アカウントのバインド:SSO 初回ログイン時に、メールアドレスが既存の Guance アカウントと一致する場合、自動的にバインドされ、履歴データが保持されます。
  5. マッピングフィールドのエラー:設定したマッピングフィールドが IdP から実際に返されるフィールドと一致しない場合、ユーザー情報を取得できず、ログインに失敗します。

関連情報

以下のコンテンツもご参照ください。

フィードバック

このページは役に立ちましたか?