を使用したシングルサインオンもサポートしています OAuth、 JWT、 SAML、 LDAP、SQL、および OpenID。

SSO API の概要

シングルサインオン (SSO) API を使用して、訪問者をフォーラムに自動的にログインさせることができます。これは、Web サイトに別のログインエリアがあり、訪問者に 2 回ログインさせたくない場合に便利です。

SSO API を使用すると、API リクエストを作成してユーザーのログイントークンを取得し、それをフォーラムアドレスに含めてユーザーをログインさせることができます。

SSO API のセットアップ

SSO API をウェブサイトに統合するには、以下の手順に従ってください。

1. API キーを取得

2. ログイントークンをリクエストする

   Web サイトのログインスクリプトで、次のように記述します。 HTTP リクエスト SSO API のログイン URL にアクセスしてください。
   https://FORUM_DOMAIN/register/setauthtoken?type=json&apikey =パイキー&ユーザー=ユーザ
   置換 パイキー ステップ 1 で取得した API キーを使用します。

   置換 ユーザ ログインしたいフォーラムユーザーのユーザー名を入力します。ウェブサイトでユーザー名を使用していない場合は、次のことができます。 電子メールアドレスをユーザー名として使用する。

   オプションで以下を含めることができます &Eメール=Eメール 指定したフォーラムアカウントがまだ存在しない場合に、フォーラムアカウントを自動的に作成したい場合はパラメータを指定します。email パラメーターを含めることをおすすめします。(EMAIL はユーザーのメールアドレスに置き換えてください)。

   オプションで行うこともできます 他のアカウント情報を指定してください、ユーザーのフルネーム、アバター、など 割り当てるユーザーグループ。その他のパラメーターは URL エンコードする必要があります。

   PHP を使用している場合は、次の PHP を使用することを強くお勧めします。 PHP SSO ライブラリ。必要なすべてのライブラリコードを含む 1 つのファイルと、使用例を含む他のファイルが含まれています。

3. レスポンスからトークンを取得

   HTTP リクエストによって返された JSON を解析して認証トークンとユーザー ID を取得し、それを Cookie またはデータベースに保存します。高レベルのセキュリティを確保するため、認証トークンは 6 か月後、または使用後すぐに期限切れになります。JSON レスポンスは次のようになります。

   {
    「認証トークン」:「88sngrvarwrsz053LFRQL」,
    「ユーザ ID」: 424764
   }
   

   エラーが発生した場合、通常の JSON 応答ではなく、以下の JSON のような JSON が表示されます。

   {
    「message」:「エラーメッセージはここに表示されます。」
   }
   

4. トークンを使用してユーザーをログインさせます

   Web サイトのフォーラムのリンクに認証トークンを渡します。例えば:
   認証トークン&覚えておいてください=覚えている「>フォーラム

   置換 認証トークン 前のステップで取得した認証トークンを使用します。置換 覚えている ブラウザを閉じた後もユーザーのログイン状態を保ちたい場合は1を、ブラウザセッションの終了時にユーザーをログアウトさせたい場合は除外します。

   埋め込みコードを使用している場合は、認証トークンをフォーラムが埋め込まれているページまたはフォーラム内に渡すことができます src 埋め込みコードの属性。例えば:

   
   

   または、フォーラムアドレスで認証トークンを渡したくない場合は、「ログイン成功」ランディングページに次の HTML IMG タグを追加できます。

   認証トークン&覚えておいてください=覚えている「ボーダー=" 0" 幅= "1" 高さ=" 1" alt= "" >

   サードパーティ Cookie が Safari ブラウザでブロックされているため、IMG タグによるアプローチは、以下の条件を満たさない限り Safari では機能しません。 ドメインをフォーラムに接続しました。

5. トークンを使用してユーザーをログアウトします

   ユーザーがWebサイトからログアウトした後、次のアドレスにリダイレクトして、フォーラムからもログアウトしてください。

   https://FORUM_DOMAIN/register/logout?authtoken =認証トークン&リダイレクト =REDIRECT_URL

   置換 REDIRECT_URL ユーザーがフォーラムからログアウトした後に送信したいURLエンコードされたWebサイトのアドレスを指定します。置換 認証トークン 前のステップで取得した認証トークンを使用します。ログアウトの目的で使用した場合、トークンはすでにユーザーのログインに使用されていたとしても、6 か月間有効です。トークンをユーザーのログアウトに使用すると、トークンはすぐに期限切れになります。

   また、ユーザーをリダイレクトしたくない場合は、ウェブサイトの「ログアウト成功」ランディングページに次の HTML IMG タグを追加することもできます。

   認証トークン「ボーダー=" 0" 幅= "1" 高さ=" 1" alt= "" >

   サードパーティ Cookie が Safari ブラウザでブロックされているため、IMG タグによるアプローチは、以下の条件を満たさない限り Safari では機能しません。 ドメインをフォーラムに接続しました。

6. フォーラムにWebサイトのログインページを使わせる

   の中に 設定-> シングルサインオン Website Toolboxアカウントのセクションで、Webサイトのアドレスを指定してください ログインページ すべてのフォーラムログインがウェブサイトのログインフォームを使用して行われるようにするため。

   ユーザーをログインページに誘導すると、 リクエスト URI URL のパラメーター。このパラメーターには、ユーザーがアクセスしたページパス (例:/categories) が格納されます。こうすることで、ユーザーがログインした後に、同じページに戻すことができます。

7. フォーラムにWebサイトのログアウトページを使用させる

   オプションで 設定-> シングルサインオン Website Toolboxアカウントのセクションで、Webサイトのアドレスを指定してください ログアウトページ ユーザーがフォーラムからログアウトした後に、ウェブサイトのログアウトページが表示されるようにします。

を使う カスタムドメイン そして私たち 埋め込みコード、 API そして ウェブフック より深い統合を実現するために。