Skip to content

homerealmdiscoverypolicy-post-homerealmdiscoverypolicies.md

Latest commit

 

History

History
144 lines (104 loc) · 5.19 KB

homerealmdiscoverypolicy-post-homerealmdiscoverypolicies.md

File metadata and controls

144 lines (104 loc) · 5.19 KB
title Create homeRealmDiscoveryPolicy
description Create a new homeRealmDiscoveryPolicy.
ms.localizationpriority medium
author nickludwig
ms.subservice entra-sign-in
doc_type apiPageType
ms.date 04/05/2024

Create homeRealmDiscoveryPolicy

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Create a new homeRealmDiscoveryPolicy object.

[!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]

HTTP request

POST /policies/homeRealmDiscoveryPolicies

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-type application/json

Request body

In the request body, supply a JSON representation of homeRealmDiscoveryPolicy object.

Response

If successful, this method returns a 201 Created response code and a new homeRealmDiscoveryPolicy object in the response body.

Examples

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/beta/policies/homeRealmDiscoveryPolicies
Content-type: application/json

{
    "definition": [
      "{\"HomeRealmDiscoveryPolicy\":{\"AccelerateToFederatedDomain\":true,\"PreferredDomain\":\"federated.example.edu\",\"AlternateIdLogin\":{\"Enabled\":true}}}"
    ],
    "displayName": "displayName-value",
    "isOrganizationDefault": true
}

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 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#policies/homeRealmDiscoveryPolicies/$entity",
    "id": "8f865ec2-2b02-405f-91e7-cb580dfdfa56",
    "deletedDateTime": null,
    "definition": [
        "{\"HomeRealmDiscoveryPolicy\":     {\"AccelerateToFederatedDomain\":true,      \"PreferredDomain\":\"federated.example.edu\",      \"AlternateIdLogin\":{\"Enabled\":true}}}"
    ],
    "displayName": "displayName-value",
    "isOrganizationDefault": true
}