Get a directory setting template

A directory setting template represents a template of settings from which settings may be created within a tenant. This operation allows retrieval of the properties of the directorySettingTemplate object, including the available settings and their defaults.


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

HTTP request

GET /directorySettingTemplates/{id}

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.


If successful, this method returns a 200 OK response code and directorySettingTemplate object in the response body.



Here is an example of the request.


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: 270

  "id": "id-value",
  "displayName": "displayName-value",
  "description": "description-value",
  "values": [
      "name": "name-value",
      "type": "type-value",
      "defaultValue": "defaultValue-value",
      "description": "description-value"