How to build Google Workspace enterprise SSO with PHP

新しい友達のために:

Logto は、モダンなアプリや SaaS 製品向けに設計された Auth0 の代替です。 Cloud とオープンソースの両方のサービスを提供し、アイデンティティと管理 (IAM) システムを迅速に立ち上げるのに役立ちます。認証 (Authentication)、認可 (Authorization)、マルチテナント管理をすべて一つにまとめて楽しんでください。

Logto Cloud で無料の開発テナントから始めることをお勧めします。これにより、すべての機能を簡単に探索できます。

この記事では、PHP と Logto を使用して、Google Workspace enterprise SSO サインイン体験（ユーザー認証 (Authentication)）を迅速に構築する手順を説明します。

前提条件

稼働中の Logto インスタンス。紹介ページをチェックして始めてください。
PHP の基本的な知識。
使用可能な Google Workspace enterprise SSO アカウント。

Create an application in Logto

Logto は OpenID Connect (OIDC) 認証 (Authentication) と OAuth 2.0 認可 (Authorization) に基づいています。これは、複数のアプリケーション間でのフェデレーテッドアイデンティティ管理をサポートし、一般的にシングルサインオン (SSO) と呼ばれます。

あなたの Traditional web アプリケーションを作成するには、次の手順に従ってください：

Logto コンソールを開きます。「Get started」セクションで、「View all」リンクをクリックしてアプリケーションフレームワークのリストを開きます。あるいは、Logto Console > Applications に移動し、「Create application」ボタンをクリックします。
開いたモーダルで、左側のクイックフィルターチェックボックスを使用して、利用可能なすべての "Traditional web" フレームワークをフィルタリングするか、"Traditional web" セクションをクリックします。"Laravel" フレームワークカードをクリックして、アプリケーションの作成を開始します。
アプリケーション名を入力します。例：「Bookstore」と入力し、「Create application」をクリックします。

🎉 タダーン！Logto で最初のアプリケーションを作成しました。詳細な統合ガイドを含むお祝いページが表示されます。ガイドに従って、アプリケーションでの体験を確認してください。

Integrate Laravel SDK

このガイドでは、Logto を PHP ウェブアプリケーションに統合する方法を示します。

ヒント:

例は Laravel を使用していますが、他のフレームワークでも概念は同じです。

インストール

composer require logto/sdk

LogtoClient の初期化

まず、Logto の設定を作成します：

index.php
use Logto\Sdk\LogtoClient;
use Logto\Sdk\LogtoConfig;

$client = new LogtoClient(
  new LogtoConfig(
    endpoint: "https://you-logto-endpoint.app",
    appId: "replace-with-your-app-id",
    appSecret: "replace-with-your-app-secret",
  ),
);

ヒント:

「App Secret」は管理コンソールのアプリケーション詳細ページから見つけてコピーできます：

デフォルトでは、SDK は組み込みの PHP セッションを使用して Logto データを保存します。他のストレージを使用したい場合は、カスタムストレージオブジェクトを 2 番目のパラメーターとして渡すことができます：

index.php
$client = new LogtoClient(
  new LogtoConfig(
    // ...
  ),
  new YourCustomStorage(),
);

詳細については、Storage を参照してください。

リダイレクト URI の設定

詳細に入る前に、エンドユーザー体験の概要を簡単にご紹介します。サインインプロセスは次のようにシンプルにまとめられます：

アプリがサインインメソッドを呼び出します。
ユーザーは Logto のサインインページにリダイレクトされます。ネイティブアプリの場合は、システムブラウザが開かれます。
ユーザーがサインインし、アプリ（リダイレクト URI として設定）に戻されます。

この認証 (Authentication) プロセスは OpenID Connect (OIDC) プロトコルに従い、Logto はユーザーのサインインを保護するために厳格なセキュリティ対策を講じています。
複数のアプリがある場合、同じアイデンティティプロバイダー (Logto) を使用できます。ユーザーがあるアプリにサインインすると、Logto は別のアプリにアクセスした際に自動的にサインインプロセスを完了します。

リダイレクトベースのサインインの理論と利点について詳しく知るには、Logto サインイン体験の説明を参照してください。

注記:

以下のコードスニペットでは、あなたのアプリが http://localhost:3000/ で実行されていると仮定しています。

リダイレクト URI を設定する

Logto Console のアプリケーション詳細ページに移動します。リダイレクト URI http://localhost:3000/callback を追加します。

サインインと同様に、ユーザーは共有セッションからサインアウトするために Logto にリダイレクトされるべきです。完了したら、ユーザーをあなたのウェブサイトに戻すと良いでしょう。例えば、http://localhost:3000/ をサインアウト後のリダイレクト URI セクションとして追加します。

その後、「保存」をクリックして変更を保存します。

コールバックの処理

ユーザーがサインインした後、Logto はユーザーを Logto コンソールで設定したコールバック URL にリダイレクトします。この例では、/callback をコールバック URL として使用します：

Route::get('/callback', function () {
  try {
    $client->handleSignInCallback(); // 多くの処理を行います
  } catch (\Throwable $exception) {
    return $exception; // これをエラーハンドリングロジックに変更してください
  }
  return redirect('/'); // サインインが成功した後、ユーザーをホームページにリダイレクトします
});

あなたの Web アプリケーションで、ユーザーからのサインインリクエストを適切に処理するためのルートを追加します。例えば：

Route::get('/sign-in', function () {
return redirect($client->signIn('http://localhost:3000/callback'));
});

このアプリケーションのために Logto コンソールで設定したコールバック URL に http://localhost:3000/callback を置き換えてください。

最初の画面にサインアップページを表示したい場合は、interactionMode を signUp に設定できます：

Route::get('/sign-in', function () {
return redirect($client->signIn('http://localhost:3000/callback', InteractionMode::signUp));
});

これで、ユーザーが http://localhost:3000/sign-in を訪れるたびに、新しいサインイン試行が開始され、ユーザーは Logto のサインインページにリダイレクトされます。

注意サインインルートを作成することは、サインイン試行を開始する唯一の方法ではありません。常に signIn メソッドを使用してサインイン URL を取得し、ユーザーをそれにリダイレクトすることができます。

サインアウトルートの実装

ユーザーがサインアウトリクエストを行った後、Logto はセッション内のすべてのユーザー認証 (Authentication) 情報をクリアします。

PHP セッションと Logto セッションをクリーンアップするために、次のようにサインアウトルートを実装できます：

Route::get('/sign-out', function () {
return redirect(
  // サインアウトが成功した後、ユーザーをホームページにリダイレクトします
  $client->signOut('http://localhost:3000/')
);
});

postLogoutRedirectUri はオプションであり、提供されない場合、ユーザーはサインアウトが成功した後に Logto のデフォルトページにリダイレクトされます（あなたのアプリケーションに戻るリダイレクトは行われません）。

注 > postLogoutRedirectUri という名前は、OpenID Connect RP-Initiated Logout 仕様から来ています。Logto は「サインアウト」を「ログアウト」の代わりに使用していますが、概念は同じです。

認証 (Authentication) ステータスの処理

Logto SDK では、$client->isAuthenticated() を使用して認証 (Authentication) ステータスを確認できます。ユーザーがサインインしている場合、この値は true になります。そうでない場合、この値は false になります。

デモ用にホームページを実装する必要があります：

ユーザーがサインインしていない場合、サインインボタンを表示します。
ユーザーがサインインしている場合、サインアウトボタンを表示します。

Route::get('/', function () {
  if ($client->isAuthenticated() === false) {
    return "Not authenticated <a href='/sign-in'>Sign in</a>";
  }

  return "<a href='/sign-out'>Sign out</a>";
});

チェックポイント: アプリケーションをテストする

これで、アプリケーションをテストできます：

アプリケーションを実行すると、サインインボタンが表示されます。
サインインボタンをクリックすると、SDK がサインインプロセスを初期化し、Logto のサインインページにリダイレクトされます。
サインインすると、アプリケーションに戻り、サインアウトボタンが表示されます。
サインアウトボタンをクリックして、トークンストレージをクリアし、サインアウトします。

Add Google Workspace enterprise SSO connector

アクセス管理を簡素化し、大規模なクライアント向けにエンタープライズレベルの保護を得るために、Laravel をフェデレーテッドアイデンティティプロバイダーとして接続します。Logto エンタープライズシングルサインオン (SSO) コネクターは、いくつかのパラメーター入力を許可することで、この接続を数分で確立するのに役立ちます。

エンタープライズ SSO コネクターを追加するには、次の手順に従ってください：

Logto コンソール > エンタープライズ SSO に移動します。

「エンタープライズコネクターを追加」ボタンをクリックし、SSO プロバイダーのタイプを選択します。Microsoft Entra ID (Azure AD)、Google Workspace、Okta の事前構築されたコネクターから選択するか、標準の OpenID Connect (OIDC) または SAML プロトコルを使用してカスタム SSO 接続を作成します。
一意の名前を指定します（例：Acme Company の SSO サインイン）。

「接続」タブで IdP と接続を構成します。各コネクタータイプのガイドを上記で確認してください。

「体験 (Experience)」タブで SSO 体験と企業の メールドメイン をカスタマイズします。SSO 対応のメールドメインでサインインするユーザーは、SSO 認証にリダイレクトされます。

変更を保存します。

Set up Google Cloud Platform

ステップ 1: Google Cloud Platform で新しいプロジェクトを作成する

Google Workspace を認証 (Authentication) プロバイダーとして使用する前に、Google API Console でプロジェクトを設定し、OAuth 2.0 資格情報を取得する必要があります。すでにプロジェクトがある場合は、このステップをスキップできます。そうでない場合は、Google 組織の下で新しいプロジェクトを作成してください。

新しい OIDC 資格情報を作成するには、アプリケーションの同意画面を設定する必要があります。

OAuth 同意画面ページに移動し、Internal ユーザータイプを選択します。これにより、OAuth アプリケーションは組織内のユーザーのみが利用可能になります。

ページの指示に従って Consent Screen 設定を入力します。次の最低限の情報を提供する必要があります：

アプリケーション名：アプリケーションの名前です。同意画面に表示されます。
サポートメール：アプリケーションのサポートメールです。同意画面に表示されます。

アプリケーションの Scopes を設定します。ユーザーのアイデンティティ情報とメールアドレスを IdP から適切に取得するために、Logto SSO コネクターは IdP から次のスコープを付与する必要があります：

openid：このスコープは OIDC 認証 (Authentication) に必要です。ID トークンを取得し、IdP の userInfo エンドポイントにアクセスするために使用されます。
profile：このスコープはユーザーの基本的なプロフィール情報にアクセスするために必要です。
email：このスコープはユーザーのメールアドレスにアクセスするために必要です。

Save ボタンをクリックして同意画面の設定を保存します。

ステップ 3: 新しい OAuth 資格情報を作成する

Credentials ページに移動し、Create Credentials ボタンをクリックします。ドロップダウンメニューから OAuth client ID オプションを選択して、アプリケーション用の新しい OAuth 資格情報を作成します。

次の情報を入力して OAuth 資格情報の設定を続行します：

アプリケーションタイプとして Web application を選択します。
クライアントアプリケーションの Name を入力します。例えば、Logto SSO Connector。これにより、将来的に資格情報を識別するのに役立ちます。
Authorized redirect URIs に Logto のコールバック URI を入力します。これは、Google が認証 (Authentication) に成功した後にユーザーのブラウザをリダイレクトする URI です。ユーザーが IdP での認証に成功した後、IdP はユーザーのブラウザをこの指定された URI に認可 (Authorization) コードと共にリダイレクトします。Logto は、この URI から受け取った認可 (Authorization) コードに基づいて認証 (Authentication) プロセスを完了します。
Authorized JavaScript origins に Logto コールバック URI のオリジンを入力します。これにより、あなたの Logto アプリケーションのみが Google OAuth サーバーにリクエストを送信できるようになります。
Create ボタンをクリックして OAuth 資格情報を作成します。

ステップ 4: クライアント資格情報で Logto コネクターを設定する

OAuth 資格情報の作成に成功すると、クライアント ID とクライアントシークレットが表示されるプロンプトモーダルが表示されます。

Client ID と Client secret をコピーし、Logto の SSO コネクターの Connection タブの対応するフィールドに入力します。

これで、Logto 上で Google Workspace SSO コネクターの設定が完了しました。

ステップ 5: 追加のスコープ (Scopes)（オプション）

スコープ (Scopes) は、アプリがユーザーから要求する権限 (Permissions) を定義し、Google Workspace アカウントからアプリがアクセスできるデータを制御します。Google の権限 (Permissions) をリクエストするには、両方の側で設定が必要です：

Google Cloud Console での操作：

APIs & Services > OAuth consent screen > Scopes に移動します。
Add or Remove Scopes をクリックし、アプリに必要なスコープ (Scopes) のみを選択します：
- 認証 (Authentication)（必須）:
  - https://www.googleapis.com/auth/userinfo.email
  - https://www.googleapis.com/auth/userinfo.profile
  - openid
- API アクセス（任意）：アプリに必要な追加スコープ (Scopes) を追加します（例：Drive、Calendar、YouTube）。利用可能なサービスは Google API ライブラリで確認できます。アプリが基本的な権限 (Permissions) 以上の Google API へのアクセスを必要とする場合は、まず Google API ライブラリでアプリが使用する特定の API（例：Google Drive API、Gmail API、Calendar API）を有効にしてください。
Update をクリックして選択を確定します。
Save and Continue をクリックして変更を適用します。

Logto Google Workspace コネクター (Connector) での操作：

Logto は、基本的なユーザーアイデンティティ情報を取得するために openid、profile、email のスコープ (Scopes) を自動的に含めます。基本的なユーザー情報のみが必要な場合は、Scopes フィールドを空欄のままにできます。
Google からさらに多くのデータをリクエストする場合は、Scopes フィールドに追加のスコープ (Scopes)（スペース区切り）を入力します。スコープ (Scopes) の URL は完全な形式で入力してください。例：https://www.googleapis.com/auth/calendar.readonly

ヒント:

アプリがこれらのスコープ (Scopes) をリクエストして Google API にアクセスし操作を行う場合は、Logto Google コネクターで Store tokens for persistent API access を有効にしてください。詳細は次のセクションを参照してください。

ステップ 6: Google API へアクセスするためのトークンを保存する（オプション）

Google APIs へアクセスし、ユーザーの認可 (Authorization) で操作を行いたい場合、Logto は特定の API スコープとトークンを取得して保存する必要があります。

必要なスコープを Google Cloud Console の OAuth 同意画面設定および Logto の Google コネクターに追加します。
Logto の Google コネクターで 永続的な API アクセスのためにトークンを保存 を有効にします。Logto は Google のアクセストークンおよびリフレッシュトークンを Secret Vault に安全に保存します。
リフレッシュトークンが返されるようにするには、Logto の Google コネクターで オフラインアクセス を有効にしてください。

警告:

Logto の Scope フィールドに offline_access を追加する必要はありません — 追加するとエラーになる場合があります。Google はオフラインアクセスが有効な場合、自動的に access_type=offline を使用します。

ステップ 7: メールドメインを設定し、SSO コネクターを有効化する

Logto のコネクター「SSO 体験」タブで、組織の メールドメイン を入力してください。これにより、指定したユーザーに対して SSO コネクターが認証 (Authentication) 方法として有効になります。

指定したドメインのメールアドレスを持つユーザーは、唯一の認証 (Authentication) 方法として SSO コネクターを利用するようリダイレクトされます。

Google Workspace SSO コネクターの詳細については、 Google OpenID Connector をご確認ください。

Save your configuration

Logto コネクター設定エリアで必要な値をすべて記入したことを確認してください。「保存して完了」または「変更を保存」をクリックすると、Google Workspace enterprise SSO コネクターが利用可能になります。

エンタープライズコネクターを個別に設定する必要はありません。Logto は、ワンクリックでアプリケーションに SSO 統合を簡素化します。

移動先： Console > サインイン体験 > サインアップとサインイン。
「エンタープライズシングルサインオン (SSO)」トグルを有効にします。
変更を保存します。

有効にすると、サインインページに「シングルサインオン (SSO)」ボタンが表示されます。SSO が有効なメールドメインを持つエンタープライズユーザーは、エンタープライズアイデンティティプロバイダー (IdP) を使用してサービスにアクセスできます。

SP 主導の SSO や IdP 主導の SSO を含む SSO ユーザー体験について詳しくは、ユーザーフロー：エンタープライズ SSO を参照してください。

Testing and Validation

PHP アプリに戻ります。これで Google Workspace enterprise SSO を使用してサインインできるはずです。お楽しみください！

Create an application in Logto​

Integrate Laravel SDK​

インストール​

LogtoClient の初期化​

リダイレクト URI の設定​

リダイレクトベースのサインインについて​

リダイレクト URI を設定する​

コールバックの処理​

サインインルートの実装​

サインアウトルートの実装​

認証 (Authentication) ステータスの処理​

チェックポイント: アプリケーションをテストする​

Add Google Workspace enterprise SSO connector​

Set up Google Cloud Platform​

ステップ 1: Google Cloud Platform で新しいプロジェクトを作成する​

ステップ 2: アプリケーションの同意画面 (Consent screen) を設定する​

ステップ 3: 新しい OAuth 資格情報を作成する​

ステップ 4: クライアント資格情報で Logto コネクターを設定する​

ステップ 5: 追加のスコープ (Scopes)（オプション）​

ステップ 6: Google API へアクセスするためのトークンを保存する（オプション）​

ステップ 7: メールドメインを設定し、SSO コネクターを有効化する​

Save your configuration​

Enable Google Workspace enterprise SSO connector in Sign-in Experience​

Testing and Validation​

Further readings​

Create an application in Logto

Integrate Laravel SDK

インストール

LogtoClient の初期化

リダイレクト URI の設定

リダイレクトベースのサインインについて

リダイレクト URI を設定する

コールバックの処理

サインインルートの実装

サインアウトルートの実装

認証 (Authentication) ステータスの処理

チェックポイント: アプリケーションをテストする

Add Google Workspace enterprise SSO connector

Set up Google Cloud Platform

ステップ 1: Google Cloud Platform で新しいプロジェクトを作成する

ステップ 2: アプリケーションの同意画面 (Consent screen) を設定する

ステップ 3: 新しい OAuth 資格情報を作成する

ステップ 4: クライアント資格情報で Logto コネクターを設定する

ステップ 5: 追加のスコープ (Scopes)（オプション）

ステップ 6: Google API へアクセスするためのトークンを保存する（オプション）

ステップ 7: メールドメインを設定し、SSO コネクターを有効化する

Save your configuration

Enable Google Workspace enterprise SSO connector in Sign-in Experience

Testing and Validation

Further readings