Skip to content

directorysettingtemplate-list.md

Latest commit

 

History

History
165 lines (137 loc) · 6.41 KB

directorysettingtemplate-list.md

File metadata and controls

165 lines (137 loc) · 6.41 KB
title List directorySettingTemplates
description This operation retrieves the list of available directorySettingTemplates objects.
ms.localizationpriority medium
author yuhko-msft
ms.reviewer mbhargav, khotzteam, aadgroupssg
ms.subservice entra-directory-management
doc_type apiPageType
ms.date 10/25/2024

List directorySettingTemplates

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Directory setting templates represents a set of templates of directory settings, from which directory settings may be created and used within a tenant. This operation retrieves the list of available directorySettingTemplates 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 groupSettingTemplate.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

Important

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 Joined Device Local Administrator - basic properties only
  • Directory Readers
  • Global Reader

HTTP request

GET /directorySettingTemplates

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 collection of directorySettingTemplate objects in the response body.

Example

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/directorySettingTemplates

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

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#directorySettingTemplates",
  "value": [
    {
      "id": "08d542b9-071f-4e16-94b0-74abb372e3d9",
      "deletedDateTime": null,
      "displayName": "Group.Unified.Guest",
      "description": "Settings for a specific Unified Group",
      "values": [
        {
          "name": "AllowToAddGuests",
          "type": "System.Boolean",
          "defaultValue": "true",
          "description": "Flag indicating if guests are allowed in a specific Unified Group."
        }
      ]
    },
    {
      "id": "80661d51-be2f-4d46-9713-98a2fcaec5bc",
      "deletedDateTime": null,
      "displayName": "Prohibited Names Settings",
      "description": "Setting templates define the different settings that can be used for the associated ObjectSettings. This template defines settings that can be used for managing tenant-wide prohibited names settings.",
      "values": [
        {
          "name": "CustomBlockedSubStringsList",
          "type": "System.String",
          "defaultValue": "",
          "description": "A comma delimited list of substring reserved words to block for application display names."
        },
        {
          "name": "CustomBlockedWholeWordsList",
          "type": "System.String",
          "defaultValue": "",
          "description": "A comma delimited list of reserved words to block for application display names."
        }
      ]
    }  
  ]
}