この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

Newer Version Available

This content describes an older version of this product. View Latest

UserManagement クラス

エンドユーザの管理 (検証方法の登録や、Salesforce でエンドユーザが認識されないようにするための要求の処理など) を行うためのメソッドがあります。

名前空間

System

使用方法

register および deregister メソッドは、ID 検証方法を登録および登録解除するために使用します。obfuscateUser メソッドは、ユーザの要求に応じてユーザオブジェクトデータをスクランブルするために使用します。formatPhoneNumber メソッドは、電話番号を正しく書式設定するために使用します。

このクラスは、API バージョン 43.0 で導入されています。以前のバージョンでは使用できません。

UserManagement メソッド

UserManagement のメソッドは次のとおりです。

clone()

System.UserManagement オブジェクトの重複コピーを作成します。

署名

public Object clone()

戻り値

型: UserManagement

deregisterVerificationMethod(userId, method)

ユーザ ID 検証方法の登録を解除します。このメソッドを使用して、ユーザが既存の検証方法を削除できるようにします。

署名

public static void deregisterVerificationMethod(Id userId, Auth.VerificationMethod method)

パラメータ

userId
型: Id
検証方法の登録を解除しているユーザのユーザ ID。
method
型: Auth.VerificationMethod
ユーザの ID の検証に使用する検証方法。

戻り値

型: void

使用方法

このメソッドを使用して、既存の ID 検証方法の登録を解除します。たとえば、ユーザは電話番号が変更されたときに、電話番号の登録を解除できます。ID 検証方法を登録できるのはエンドユーザのみですが、登録の解除は開発者とユーザが実行できます。カスタム登録ページを実装するときは、この動作に留意してください。

このメソッドは、API バージョン 43.0 で導入されました。以前のバージョンでは使用できません。

formatPhoneNumber(countryCode, phoneNumber)

ユーザの携帯電話番号を書式設定します。ユーザの携帯電話番号を更新する前に、このメソッドをコールして、電話番号が適切に書式設定されていることを確認します。

署名

global static String formatPhoneNumber(String countryCode, String phoneNumber)

パラメータ

countryCode
型: String
有効な国コード。
phoneNumber
型: String
国コードは除いて 3 ~ 49 文字の数値を含む携帯番号。たとえば、(415) 555-1234 など。

戻り値

型: String

ユーザの携帯電話番号を適切な形式で返します。

使用方法

このメソッドを使用して、ユーザの携帯電話番号が Salesforce で要求される形式になるようにします。次に、このメソッドの戻り値を使用して、ユーザのレコードの mobile 項目を更新します。この携帯番号は、SMS ベースの ID 確認に使用されます。たとえば、携帯電話番号は他の ID 検証方法と共に Auth.VerificationMethod 列挙に保存されます。このメソッドは、API バージョン 43.0 で導入されました。以前のバージョンでは使用できません。

ユーザが携帯番号の入力時に使用できる形式を次にいくつか示します。

  • +1, (415) 555-1234 (+ 記号、括弧、ダッシュを含む)
  • 1, 4155551234 (数字のみで記号を含まない)
  • 1 , 415-555-1234 (余分なスペース)

次の例を考えてみます。

  • 正しい例:
    • formatPhoneNumber('1', '4155551234');
    • formatPhoneNumber('+1','(415) 555-1234');
    • formatPhoneNumber('1', '415-555-1234');
  • 国コードと携帯番号が分かれているため、正しくない例:
    • formatPhoneNumber(null, '+1 415-555-1234');
  • エラーは発生しないが、適切に機能しない可能性が高い例:
    • formatPhoneNumber('+1', '+1 (415) 555-1234');

formatPhoneNumber コードの例

formatPhoneNumber メソッドを使用したコードの例を次に示します。ユーザの携帯番号を取得し、それを Salesforce で要求される形式に変換します。次に、書式設定された携帯番号でユーザのレコードを更新します。

国コードと電話番号が分かれていれば、formatPhoneNumber は適切な形式で値を返します。

obfuscateUser(userId, username)

Salesforce で個人データが認識されることをユーザが望まなくなった場合に要求に応じてユーザのデータをスクランブルします。ユーザに対してこのメソッドを呼び出すと、データが匿名になり、そのデータを復元することはできなくなります。このメソッドを使用して、スクランブル後にユーザ名を特定の値に設定します。

署名

public static void obfuscateUser(Id userId, String username)

パラメータ

userId
型: Id
このメソッドでスクランブルするデータを所有するユーザの ID。
username
型: String
ユーザのデータがスクランブルされた後のユーザ名。スクランブルされたユーザ名の値を特定の文字列に設定します。

戻り値

型: void

使用方法

このメソッドは、API バージョン 43.0 で導入されました。以前のバージョンでは使用できません。

obfuscateUser メソッドを使用して、組織のユーザの個人情報を保護します。呼び出されたときに、ユーザのオブジェクトデータは完全にスクランブルされて、ランダムな文字列に置換されます。ユーザの詳細ページは存在しますが、項目には意味のない文字列が含まれます。Salesforce でユーザを削除することはできず、無効化のみが可能なため、個人データは単に難読化 (スクランブル) されます。つまり、ユーザレコードはデータベースに残され、このメソッドは論理削除を実行します。

このメソッドを使用する場合は注意が必要です。ユーザのデータは匿名となり、復元できません。

メモ

考慮事項

  • このメソッドでは、[設定] の組織のユーザ管理設定 [特定のユーザのデータをスクランブル] が有効になっている必要があります。
  • このメソッドはユーザオブジェクトの標準項目に影響します (ユーザ ID、タイムゾーン、ロケール、プロファイルなどの一部の項目を除く)。
  • ユーザに確認を送信する場合、ユーザの ID と後処理のための他の属性 (メールアドレスなど) を書き留めることをお勧めします。
  • このメソッドはユーザオブジェクトのみを変更します。ユーザと他のオブジェクト間の関連付けは削除されますが、他のオブジェクトは変更されません。たとえば、連絡先、ThirdPartyAccountLink (TPAL)、ユーザパスワード認証 (UPA) オブジェクトは変更されずに維持されます。

このメソッドを使用しても、メール変更通知はトリガされないことをシステム管理者に伝えてください。

メモ

このメソッドは、ユーザの個人データとプライバシー保護の取り組みの一環です。ユーザデータを積極的に保護するために実行できることについての詳細は、Salesforce ヘルプの「データ保護とプライバシー」を参照してください。

obfuscateUser(userId)

Salesforce で個人データが認識されることをユーザが望まなくなった場合に要求に応じてユーザのデータをスクランブルします。ユーザに対してこのメソッドを呼び出すと、データが匿名になり、そのデータを復元することはできなくなります。

署名

public static void obfuscateUser(Id userId)

パラメータ

userId
型: Id
このメソッドでスクランブルするデータを所有するユーザの ID。

戻り値

型: void

使用方法

このメソッドは、API バージョン 43.0 で導入されました。以前のバージョンでは使用できません。

obfuscateUser メソッドを使用して、組織のユーザの個人情報を保護します。呼び出されたときに、ユーザのオブジェクトデータは完全にスクランブルされて、ランダムな文字列に置換されます。ユーザの詳細ページは存在しますが、項目には意味のない文字列が含まれます。Salesforce でユーザを削除することはできず、無効化のみが可能なため、個人データは単に難読化 (スクランブル) されます。つまり、ユーザレコードはデータベースに残され、このメソッドは論理削除を実行します。

このメソッドを使用する場合は注意が必要です。ユーザのデータは匿名となり、復元できません。

メモ

考慮事項

  • このメソッドでは、[設定] の組織のユーザ管理設定 [特定のユーザのデータをスクランブル] が有効になっている必要があります。
  • このメソッドはユーザオブジェクトの標準項目に影響します (ユーザ ID、タイムゾーン、ロケール、プロファイルなどの一部の項目を除く)。
  • ユーザに確認を送信する場合、ユーザの ID と後処理のための他の属性 (メールアドレスなど) を書き留めることをお勧めします。
  • このメソッドはユーザオブジェクトのみを変更します。ユーザと他のオブジェクト間の関連付けは削除されますが、他のオブジェクトは変更されません。たとえば、連絡先、ThirdPartyAccountLink (TPAL)、ユーザパスワード認証 (UPA) オブジェクトは変更されずに維持されます。

このメソッドを使用しても、メール変更通知はトリガされないことをシステム管理者に伝えてください。

メモ

このメソッドは、ユーザの個人データとプライバシー保護の取り組みの一環です。ユーザデータを積極的に保護するために実行できることについての詳細は、Salesforce ヘルプの「データ保護とプライバシー」を参照してください。

ObfuscateUser コード例

registerVerificationMethod(method, startUrl)

ID 検証方法を登録します。検証方法には、時間ベースのワンタイムパスワード、メールまたはテキストのワンタイムパスワード、Salesforce Authenticator、U2F などがあります。エンドユーザは検証方法を登録します。

署名

public static System.PageReference registerVerificationMethod(Auth.VerificationMethod method, String startUrl)

パラメータ

method
型: Auth.VerificationMethod
ユーザの ID の検証に使用する検証方法。
startUrl
型: String
ログイン後にユーザに表示するページへのパス。

戻り値

型: System.PageReference

使用方法

このメソッドを使用して、2FA などの ID 検証を完了するか、パスワードなしでコミュニティにログインします。ユーザは、ログインするときに ID を検証するこれらの方法に登録します。開発者は、モバイルで使いやすいパスワードなしのログインを実装する場合にカスタム登録ページを作成します。「passwordlessLogin」を参照してください。

registerVerificationMethod で返された PageReference は、ユーザを Salesforce の検証ページにリダイレクトします。ユーザが正しいコードを入力すると、開始 URL で指定されたコミュニティページにリダイレクトされます。たとえば、次のように指定します。

このメソッドは、API バージョン 43.0 で導入されました。それより前のバージョンでは使用できません。