ユーザーがSSOプロバイダを使用してPlatformアプリケーションにログインする際、まず必要なのは、Boxユーザーレコードが作成された前回のログイン試行から、そのユーザーがすでに存在するかどうかを確認することです。
Boxユーザーが検出されたら、そのユーザーとしてBox APIにアクセスするために、するかを実行する必要があります。
Boxユーザーが検出されない場合は、そのSSOユーザーレコードに関連付けられた新しいユーザーを作成する必要があります。
既存のユーザーの検索には、エンドポイントを使用できます。external_app_user_idとloginのどちらのメソッドを使用しているかによって、クエリは若干異なります。
検索方法を選択します。検索方法は、でBoxユーザーにSSO IDを関連付けた方法と合致するものを選択する必要があります。
- BoxユーザーにSSOプロバイダの一意のIDを保存していた場合には、
external_app_user_idを使用します。これは、App Userと管理対象ユーザーのどちらにも機能します。
- ログインにSSOメールアドレスを使用する管理対象ユーザーを作成していた場合には、
loginメールアドレスを使用します。
外部App User IDを使用したユーザーの検索
格納されているexternal_app_user_id値を使用して会社ユーザーを検索するには、SSOプロバイダの次の情報が必要になります。
- UID (必須): SSOユーザーレコードの一意の識別子です。
取得したら、パラメータでexternal_app_user_id定義を指定して、会社ユーザーのリストを取得エンドポイントにリクエストを実行します。
特定のアプリケーションのApp Userを取得できるのは、そのApp Userを作成したのがこのアプリケーションである場合のみです。あるアプリケーションを使用して、別のアプリケーションで作成されたユーザーを検索した場合、データは返されません。
メールアドレスを使用したユーザーの検索
loginのメールアドレスを使用して会社ユーザーを検索するには、SSOプロバイダの次の情報が必要になります。
- メールアドレス (必須): SSOユーザーレコードの一意のメールアドレスです。
取得したら、filter_termとしてメールアドレスを指定して、会社ユーザーのリストを取得エンドポイントにリクエストを実行します。これは、メールアドレスまたは名前を使用した検索に使用できるようになります。