1. JWTに基づくユーザー認証は、Zoho Deskの設定で シングルサインオン（SSO） が有効になっている場合にのみ利用できます。シングルサインオンを有効にすると、1つのサービスに一度サインインするだけで、他のさまざまなサービスにもアクセスできるようになります。 シングルサインオンが有効になっていない場合、どこでもサポートのアドオンには、ゲストユーザーとしてのみアクセス可能です。
   
2. 複数のヘルプセンター を設置している場合、シングルサインオンの設定は標準のヘルプセンターで有効にする必要があります。
   

認証フロー（認証の流れ）

1. ユーザーが、どこでもサポートのアドオンが組み込まれているアプリケーションにサインインします。
   
2. どこでもサポートのアドオンが組み込まれているアプリケーションから、クライアントID、クライアントシークレット、JWTの署名済みトークンが、ZohoのIAM（IDを認証、管理するためのシステム）のサーバー宛てに送信されます。この際、送信されるトークンには、ユーザーのメールアドレス、認証ステータス、サインインの時間間隔などのユーザー情報が含まれます。 
   
3. IAMサーバーでは、JWTシークレットキーの暗号を解読して、以下のような認証処理を行います。
   
1. サインインしたユーザーが有効な既存ユーザーであることが確認できた場合、ユーザーがどこでもサポートのアドオンにサインインできるように認証用のOAuthトークンを生成します。
   
2. サインインしたユーザーが有効な新規ユーザーであることが確認できた場合、まずユーザーを追加してから、OAuthトークンを生成します。
   
3. サインインしたユーザーが無効なユーザーである場合、エラーメッセージを送信します。
   
   

どこでもサポートのアドオンでのJWTの仕組み

JWTエンドポイントの役割  

JWTによる認証によってどこでもサポートのアドオンにサインインできるようにするには、JWTの認証設定の前に接続先のサーバー（連携対象のアプリケーションのサーバー）の設定を行う必要があります。このサーバーがJWTエンドポイントと呼ばれます。JWTエンドポイントでは、JWTを生成するコードが実行されている必要があります。

JWTのリダイレクトURLの例： https://safe-forest-77068.herokuapp.com/getjwt?user_token=token

 

JWTエンドポイントでは、アドオン用に生成されたJWTシークレットを使用して、以下のようなコードが常時実行されている必要があります（以下はJavaの例です）。

                        
                           
                              import io.jsonwebtoken.SignatureAlgorithm;
                              import javax.crypto.spec.SecretKeySpec;
                              import java.security.Key;
                              import io.jsonwebtoken.JwtBuilder;
                              import io.jsonwebtoken.Jwts;
                              import java.io.UnsupportedEncodingException;
                              public static String generateJwt(String userToken) throws UnsupportedEncodingException{
                              String secretKey = ""; ///シークレットキーの値はアドオンが作成された後に付与されます。シークレットキーを取得したら、こちらの値として設定します
                              long notBeforeMillis = System.currentTimeMillis();
                              long notAfterMillis = notBeforeMillis + 300000;
                              SignatureAlgorithm signatureAlgorithm = SignatureAlgorithm.HS256;
                              byte[] apiKeySecretBytes = secretKey.getBytes();
                              Key signingKey = new SecretKeySpec(apiKeySecretBytes, signatureAlgorithm.getJcaName());
                              JwtBuilder builder = Jwts.builder().signWith(signatureAlgorithm, signingKey);
                              String jwt = builder.claim("email_verified", true)
                              .claim("not_after", notAfterMillis)
                              .claim("not_before", notBeforeMillis)
                              .claim("email", <user_email_address_from_user_token>).compact();
                              return jwt;
                              }  
                           
                        
                     

パラメーター	内容
userToken	アプリケーションにサインインしたユーザーの情報を、アプリケーションから取得するためのパラメーターです。
email	ユーザーのメールアドレスを返すためのパラメーターです。
email_verified	メールアドレスが認証されているかどうかを返す、真偽値（true/false）のパラメーターです。その後、OAuthのトークンをどこでもサポートのアドオンに送信します。
not_before と not_after	JWTの期限が切れるまでの時間を表します。これらのパラメーターの値は、協定世界時（UTC：Coordinated Universal Time）形式によって、ミリ秒単位で指定する必要があります。

セキュリティ強度を確保するため、not_beforeパラメーターとnot_afterパラメーターの時間差は、600,000ミリ秒（10分）を超えないようにしてください。

どこでもサポートでJWTによるユーザー認証を行うためのコード

IAMサーバーにおいて、JWTトークンに含まれるユーザー情報が認証されると、認証用のOAuthトークンが生成され、クライアントに送信されます。クライアントでは、IAMサーバーから送信されたOAuthトークンを用いて、サインインしたユーザーが有効なZohoユーザーであることを認証できるようになります。
Web
生成されたJWTトークンをZohoのIAMサーバーに共有するために使用するため、クライアントで設定するコードは以下のとおりです。

                                    
                                       
                                          window.ZohoHCAsapSettings={
                                          userInfo :{
                                          jwtToken : "generated-jwt-token"
                                          }
                                          }
                                       
                                    
                                 

Android

setUserTokenメソッドでは、送信対象のトークンがユーザートークンであるかJWTトークンであるかを、真偽値（trueまたはfalse）のパラメーターによって指定します。

MyApplication.deskInstance.setUserToken(String jwtToken, ZDPortalCallback.SetUserCallback callback, boolean isJWT);

iOS

以下のメソッドでは、送信対象のトークンとしてJWTトークンを指定しています。

ZohoDeskPortalKit.login(withJWTToken: token, onCompletion: handler)

どこでもサポートのJWT設定において、userInfoスクリプトは、アプリのスクリプトを読み込む前に実行する必要があります。