homeRealmDiscoveryPolicy resource type

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.

Represents a policy to control Azure Active Directory authentication behavior for federated users, in particular for auto-acceleration and user authentication restrictions in federated domains. You can set homeRealmDiscoveryPolicy for all service principals in your organization, or for specific service principals in your organization. For more scenario and policy details see Configure Azure AD sign in behavior for an application by using a Home Realm Discovery policy as well as Sign-in to Azure Active Directory using email as an alternate login ID.

Inherits from stsPolicy.

Methods

Method	Return Type	Description
Create homeRealmDiscoveryPolicy	homeRealmDiscoveryPolicy	Create a homeRealmDiscoveryPolicy object.
Get homeRealmDiscoveryPolicy	homeRealmDiscoveryPolicy	Read properties and relationships of a homeRealmDiscoveryPolicy object.
List homeRealmDiscoveryPolicies	homeRealmDiscoveryPolicy	Read properties and relationships of homeRealmDiscoveryPolicies objects.
Update homeRealmDiscoveryPolicy	None	Update a homeRealmDiscoveryPolicy object.
Delete homeRealmDiscoveryPolicy	None	Delete a homeRealmDiscoveryPolicy object.
List appliesTo	directoryObject collection	Get the list of directoryObjects that this policy has been applied to.
Assign homeRealmDiscoveryPolicy	None	Assign a homeRealmDiscoveryPolicy object to a servicePrincipal object.
List assigned homeRealmDiscoveryPolicy	homeRealmDiscoveryPolicy collection	List the homeRealmDiscoveryPolicy objects that are assigned to a servicePrincipal object.
Remove homeRealmDiscoveryPolicy	None	Remove a homeRealmDiscoveryPolicy object from a servicePrincipal object.

Properties

Property	Type	Description
id	String	Unique identifier for this policy. Read-only.
definition	String collection	A string collection containing a JSON string that defines the rules and settings for this policy. See Properties of a home realm discovery policy definition for more details about the JSON schema for this property. Required.
description	String	Description for this policy.
displayName	String	Display name for this policy. Required.
isOrganizationDefault	Boolean	If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false.

Properties of a home realm discovery policy definition

The properties below form the JSON object that represents a token lifetime policy. This JSON object must be converted to a string with quotations escaped to be inserted into the definition property. An example is shown below in JSON format:

"definition": [
    "{
        \"HomeRealmDiscoveryPolicy\": {
          \"AccelerateToFederatedDomain\":true,
          \"AllowCloudPasswordValidation\": false,
          \"PreferredDomain\":\"federated.example.edu\",
          \"AlternateIdLogin\":{
            \"Enabled\":true
          }
        }
      }"
  ]

Property	Type	Description
AccelerateToFederatedDomain	Boolean	Set to true for auto-acceleration (bypass home realm discovery). If true and there is only one verified and federated domain in the tenant, then users will be taken straight to the federated identity provider (such as ADFS) for sign in. If true and there is more than one verified domain in the tenant, PreferredDomain must be specified. Optional.
AllowCloudPasswordValidation	Boolean	Set to true to allow an application to authenticate a federated user by presenting username/password credentials directly to the Azure Active Directory token endpoint. Only works if Password Hash Sync is enabled. Optional.
AlternateIdLogin	Json	Set to {\"Enabled\": true} to allow Azure AD sign-in using email as an alternate login ID. Only works when IsOrganizationDefault is set to true. Optional.
PreferredDomain	String	Specifies a domain to accelerate sign-in to. It can be omitted if the tenant has only one federated domain. If it is omitted, and there is more than one verified federated domain, this policy has no effect. Required if AccelerateToFederatedDomain is true.

Relationships

Relationship	Type	Description
appliesTo	directoryObject collection	The directoryObject collection that this policy has been applied to. Read-only.

JSON representation

The following is a JSON representation of the resource.

{
  "definition": ["String"],
  "description": "String",
  "displayName": "String",
  "id": "String (identifier)",
  "isOrganizationDefault": true
}