スクラッチ組織ユーザのカスタマイズのためのユーザ定義ファイル
ユーザ定義ファイルでは JSON 形式が使用され、任意の Salesforce User sObject 項目と次の Salesforce DX 固有のオプションを含めることができます。
| Salesforce DX オプション | 説明 | 指定されていない場合のデフォルト |
|---|---|---|
| permsets | ユーザに割り当てられた権限セットの配列。複数の値はカンマで区切り、角括弧で囲みます。 以前に force:source:push を使用してスクラッチ組織に権限セットを転送している必要があります。 |
None |
| generatePassword | ブール型。ユーザにランダムなパスワードを生成するかどうかを指定します。 true に設定すると、force:user:create は完了後に生成されたパスワードを表示します。パスワードは force:user:describe を使用して参照できます。 |
False |
| profileName | ユーザに関連付けるプロファイルの名前。User sObject の ProfileId 項目に似ていますが、プロファイルの ID ではなく名前を指定します。プロファイルの名前のみを知っている場合に便利です。 | Standard User |
ユーザ定義ファイルのオプションでは大文字と小文字が区別されます。ただし、Salesforce DX 固有オプションには小文字のキャメルケースを使用し、User sObject 項目には大文字のキャメルケースを使用することをお勧めします。この形式は、他の Salesforce DX 定義ファイルと一貫性があるものです。
次のユーザ定義ファイルには、いくつかの User sObject 項目と 3 つの Salesforce DX オプション (profileName、permsets、generatePassword) が含まれています。
1{
2 "Username": "tester1@sfdx.org",
3 "LastName": "Hobbs",
4 "Email": "tester1@sfdx.org",
5 "Alias": "tester1",
6 "TimeZoneSidKey": "America/Denver",
7 "LocaleSidKey": "en_US",
8 "EmailEncodingKey": "UTF-8",
9 "LanguageLocaleKey": "en_US",
10 "profileName": "Standard Platform User",
11 "permsets": ["Dreamhouse", "Cloudhouse"],
12 "generatePassword": true
13}この例で、ユーザ名の tester1@sfdx.org は Salesforce エコシステム全体で一意である必要があります。そうでない場合は force:user:create コマンドが失敗します。Alias オプションの別名は force:user:create の --setalias パラメータで指定する別名とは異なります。Alias オプションの別名は Salesforce UI でのみ使用します。--setalias の別名は CLI を実行するコンピュータにローカルで、他の CLI コマンドでも使用できます。
ユーザ定義ファイルへのパスは、force:user:create CLI コマンドの --definitionfile パラメータで指定します。このファイルは、任意の名前を付けることができ、CLI がアクセスできる任意の場所に保存できます。
1sfdx force:user:create --setalias qa-user --definitionfile config/user-def.jsonforce:user:create を実行するときにコマンドラインで名前-値のペアとして指定することで、ユーザ定義ファイル内のオプションを上書きできます。次の例では、ユーザ名、権限セットのリスト、パスワードを生成するかどうかを上書きしています。
1sfdx force:user:create --setalias qa-user --definitionfile config/user-def.json permsets="Dreamy,Cloudy" Username=tester345@sfdx.org generatePassword=falseユーザ定義ファイルにないオプションをコマンドラインで追加することもできます。次の例では、City オプションを追加しています。
1sfdx force:user:create --setalias qa-user --definitionfile config/user-def.json City=Oakland