PermissionSetGroup (パイロット) | メタデータ API 開発者ガイド

権限セットとセット内の権限のグループを表します。権限セットグループを使用して、職務やタスクに基づいて権限を整理し、パッケージ化します。 Metadata メタデータ型を拡張し、その fullName 項目を継承します。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所

権限セットグループは permissionsetgroups ディレクトリに保存されます。ファイル名は権限セットの API 参照名に一致し、拡張子は .permissionsetgroup です。たとえば、Finance_Mgmt_PermSetGroup という名前の権限セットグループは permissionsetgroups/Finance_Mgmt_PermSetGroup.permissionsetgroup に保存されます。

バージョン

権限セットグループは API バージョン 45.0 以降で使用できます。

この機能は、特定の契約条件への同意が必要なパイロットプログラムを通じて一部のお客様に提供されています。このプログラムに参加する方法については、Salesforce にお問い合わせください。パイロットプログラムは変更される可能性があるため、参加は保証されません。このドキュメント、プレスリリース、または公式声明で参照されているこのパイロット機能は正式リリースされていません。特定期間内の正式リリースあるいはリリースの有無は保証できません。現在正式にリリースされている機能に基づいて購入をご決定ください。

メモ

項目

項目	項目の型	説明
description	string	権限セットグループの作成者が提供する権限セットグループの説明。
label	string	必須。権限セットグループの表示ラベル。
permissionSets	string	権限セットグループに含まれる 1 つ以上の権限セット。
status	string	権限セットグループの再適用の状況を示します。有効な値は、次のとおりです。 `Updated` — グループは最新です。 `Outdated` — グループに再適用が必要です。 `Updating` — グループは再適用モードになっています。 `Failed` — グループの再適用に失敗しました。

宣言的なメタデータの定義のサンプル

権限セットグループを追加する場合、次のようなことを実行できます。権限セットグループではなく、参照される権限セットに個々の権限が含まれます。

1<?xml version="1.0" encoding="UTF-8"?>
2<PermissionSetGroup xmlns="http://soap.sforce.com/2006/04/metadata">
3     <fullName>Finance_Mgmt_PermSetGroup</fullName>
4     <description>Finance_Mgmt_PermSetGroup desc</description>
5     <label>Finance_Mgmt_PermSetGroup</label>
6     <permissionSets>Billing_PS</permissionSets>
7</PermissionSetGroup>

権限セット Billing_PS には、Finance_Mgmt_PermSetGroup に含まれている個々の権限が含まれます。

1<?xml version="1.0" encoding="UTF-8"?>
2<PermissionSet xmlns="http://soap.sforce.com/2006/04/metadata">
3     <fullName>Billing_PS</fullName>
4     <description>Billing_PS</description>
5     <label>Billing_PS</label>
6     <license>Salesforce</license>
7     <userPermissions>
8          <enabled>true</enabled>
9          <name>ViewSetup</name>
10     </userPermissions>
11     <userPermissions>
12          <enabled>true</enabled>
13          <name>ViewRoles</name>
14     </userPermissions>
15     <userPermissions>
16          <enabled>true</enabled>
17          <name>EditBillingInfo</name>
18    </userPermissions>
19</PermissionSet>

この package.xml マニフェストの例では、組織の PermissionSetGroup メタデータを取得します。権限セットグループを取得する場合、関連するコンポーネントも取得します。たとえば、PermissionSetGroup を取得するには、PermissionSet も取得する必要があります。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3     <types>
4          <members>Finance_Mgmt_PermSetGroup</members>
5          <name>PermissionSetGroup</name>
6     </types>
7     <types>
8          <members>Billing_PS</members>
9          <name>PermissionSet</name>
10     </types>
11     <version>45.0</version>
12</Package>