名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
特定の ディレクトリ設定 オブジェクトのプロパティを取得します。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
|---|---|---|---|
| ✅ | ✅ | ✅ | ✅ |
アクセス許可
次の表は、サポートされている各リソースの種類でこの API を呼び出すために必要な最小特権のアクセス許可を示しています。 ベスト プラクティスに従って、最低特権のアクセス許可を要求します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
テナント全体の設定を一覧表示する
| アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
|---|---|---|
| 委任 (職場または学校のアカウント) | GroupSettings.Read.All | GroupSettings.ReadWrite.All、Directory.Read.All、Directory.ReadWrite.All、Group.Read.All、Group.ReadWrite.All |
| 委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
| アプリケーション | GroupSettings.Read.All | GroupSettings.ReadWrite.All、Directory.Read.All、Directory.ReadWrite.All、Group.Read.All、Group.ReadWrite.All |
重要
職場または学校アカウントを使用してアクセスを委任するには、サインインしたユーザーに、サポートされている Microsoft Entra ロール、またはこの操作に必要なアクセス許可を付与するカスタム ロールが割り当てられている必要があります。 この操作では、必要最小限の特権のみを提供する次の組み込みロールがサポートされます。
- テンプレートと設定に関する基本プロパティを読み取る - Microsoft Entra 参加済みデバイス ローカル管理者、ディレクトリ閲覧者、グローバル閲覧者
- すべてのグループ/ディレクトリ設定の管理 - ディレクトリ作成者
- グループのグローバル設定とローカル設定を管理します。
Group.Unified.GuestとGroup.Unifiedの設定を管理する - グループ管理者 -
Password Rule Settings- 認証ポリシー管理者を更新する - 設定の更新、設定テンプレートと設定に関する基本プロパティの読み取り - ユーザー管理者
アプリに委任された Directory.Read.All または Directory.ReadWrite.All アクセス許可が付与されている場合、サインイン ユーザーには既定のメンバー ロールのみが必要になります。 追加の Microsoft Entra ロールは必要ありません。 上記の Microsoft Entra ロールは、呼び出し元のアプリに、GroupSettings.Read.All など、より限定的な委任アクセス許可が付与されている場合にのみ必要です。 その場合、サインイン ユーザーは、一覧表示されているロールのいずれかを保持している必要があります。
グループ固有の設定を一覧表示する
| アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
|---|---|---|
| 委任 (職場または学校のアカウント) | GroupSettings.Read.All | Directory.Read.All、Directory.ReadWrite.All、Group.Read.All、Group.ReadWrite.All、GroupSettings.ReadWrite.All |
| 委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
| アプリケーション | GroupSettings.Read.All | Directory.Read.All、Directory.ReadWrite.All、Group.Read.All、Group.ReadWrite.All、GroupSettings.ReadWrite.All |
HTTP 要求
テナント全体の設定を取得します。
GET /settings/{directorySettingId}
グループ固有の設定を取得します。
GET /groups/{groupId}/settings/{directorySettingId}
オプションのクエリ パラメーター
このメソッドは、応答のカスタマイズに役立つ $selectOData クエリ パラメーター をサポートします。
要求ヘッダー
| 名前 | 説明 |
|---|---|
| Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
要求本文
このメソッドには、要求本文を指定しません。
応答
成功した場合、このメソッドは応答本文で 200 OK 応答コードと directorySetting オブジェクトを返します。
例
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/beta/settings/f0b2d6f5-097d-4177-91af-a24e530b53cc
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#settings/$entity",
"id": "f0b2d6f5-097d-4177-91af-a24e530b53cc",
"displayName": "Group.Unified",
"templateId": "62375ab9-6b52-47ed-826b-58e47e0e304b",
"values": [
{
"name": "NewUnifiedGroupWritebackDefault",
"value": "false"
},
{
"name": "EnableMIPLabels",
"value": "true"
},
{
"name": "CustomBlockedWordsList",
"value": ""
},
{
"name": "EnableMSStandardBlockedWords",
"value": "true"
},
{
"name": "ClassificationDescriptions",
"value": ""
},
{
"name": "DefaultClassification",
"value": ""
},
{
"name": "PrefixSuffixNamingRequirement",
"value": "[Contoso-][GroupName]"
},
{
"name": "AllowGuestsToBeGroupOwner",
"value": "false"
},
{
"name": "AllowGuestsToAccessGroups",
"value": "true"
},
{
"name": "GuestUsageGuidelinesUrl",
"value": "https://privacy.contoso.com/privacystatement"
},
{
"name": "GroupCreationAllowedGroupId",
"value": ""
},
{
"name": "AllowToAddGuests",
"value": "true"
},
{
"name": "UsageGuidelinesUrl",
"value": ""
},
{
"name": "ClassificationList",
"value": ""
},
{
"name": "EnableGroupCreation",
"value": "true"
}
]
}