スクラッチ組織ユーザーのカスタマイズのためのユーザー定義ファイル
ユーザー定義ファイルでは JSON 形式が使用され、任意の Salesforce User sObject 項目と次の Salesforce DX 固有のオプションを含めることができます。
| Salesforce DX オプション | 説明 | 指定がない場合のデフォルト |
|---|---|---|
| permsets | ユーザーに割り当てられた権限セットの配列。複数の値はカンマで区切り、角括弧で囲みます。 事前に project deploy start を使用してスクラッチ組織に権限セットをリリースしている必要があります。 |
None |
| generatePassword | ブール型。ユーザーにランダムなパスワードを生成するかどうかを指定します。 true に設定すると、org create user は完了後に生成されたパスワードを表示します。パスワードは org display user を使用して参照することもできます。 |
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 エコシステム全体で一意である必要があります。そうでない場合は org create user コマンドが失敗します。この場合、--set-unique-username フラグを使用することを推奨します。これにより、設定ファイルの値が上書きされ、ユーザー名の一意性が維持されます。Alias オプションの別名は org create user の --set-alias フラグで指定する別名とは異なります。Alias オプションは Salesforce UI のみで使用してください。--set-alias フラグは CLI を実行するコンピューターにローカルで適用されます。他の CLI コマンドでも使用できます。
--definition-file フラグにより、ユーザー定義ファイルへのパスが示されます。このファイルは、任意の名前を付けることができ、CLI がアクセスできる任意の場所に保存できます。
1sf org create user --set-alias qa-user --definition-file config/user-def.json --target-org my-scratchユーザー定義ファイル内のオプションは、コマンドラインで名前-値のペアとして指定することで上書きできます。この方法により、複数のユーザーまたは継続的インテグレーションジョブで基本定義ファイルを共有し、コマンドの実行時にオプションをカスタマイズできます。次の例では、ユーザー名、権限セットのリスト、パスワードを生成するかどうかを上書きしています。
1sf org create user --set-alias qa-user --definition-file config/user-def.json permsets="Dreamy,Cloudy" Username=tester345@sfdx.org generatePassword=false --target-org my-scratchユーザー定義ファイルにないオプションをコマンドラインで追加することもできます。次の例では、City オプションを追加しています。
1sf org create user --set-alias qa-user --definition-file config/user-def.json City=Oakland --target-org my-scratch