List settings
Namespace: microsoft.graph
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Retrieve a list of tenant-level or group-specific group settings objects.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
List tenant-wide settings
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | Directory.Read.All, Directory.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. |
Application | Directory.Read.All, Directory.ReadWrite.All |
List group-specific settings
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | Group.Read.All, Group.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. |
Application | Group.Read.All, Group.ReadWrite.All |
In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation.
Microsoft Entra role | Allowed privileges |
---|---|
Microsoft Entra Joined Device Local Administrator Directory Readers Global Reader |
Read basic properties on setting templates and settings |
Groups Administrator Directory Writers |
Manage all group settings |
Authentication Policy Administrator | Update Password Rule Settings |
User Administrator | Read basic properties on setting templates and settings Update settings |
HTTP request
List tenant-wide or group settings.
GET /settings
List group-specific settings.
GET /groups/{groupId}/settings
Optional query parameters
This method supports the $select
OData query parameter to help customize the response.
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and a collection of directorySetting objects in the response body.
Example
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/settings
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#settings",
"value": [
{
"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"
}
]
}
]
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for