List directory settings

Important: APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported.

Retrieve a list of directory setting objects.

Note: The /beta version of this API is only applies to groups. The /v1.0 version of this API has been renamed to List groupSettings.

Prerequisites

The following scopes are required to execute this API: Directory.Read.All or Directory.ReadWrite.All or Directory.AccessAsUser.All

HTTP request

List tenant-wide or group settings

GET /settings
GET group/{id}/settings

Optional query parameters

This method supports the OData Query Parameters to help customize the response.

Request headers

Name Description
Authorization Bearer {token}. Required.

Request body

Do not supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and collection of directorySetting objects in the response body.

Example

Request

Here is an example of the request.

GET https://graph.microsoft.com/beta/settings
Response

Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-type: application/json
Content-length: 263

{
  "value": [
    {
      "id": "id-value",
      "displayName": "displayName-value",
      "settingTemplateId": "settingTemplateId-value",
      "values": [
        {
          "name": "name-value",
          "value": "value-value"
        }
      ]
    }
  ]
}