Tipo de recurso homeRealmDiscoveryPolicy

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor de versão.

Representa uma política para controlar Azure Active Directory de autenticação para usuários federados, em particular para restrições de aceleração automática e autenticação do usuário em domínios federados. Você pode definir homeRealmDiscoveryPolicy para todas as entidades de serviço em sua organização ou para entidades de serviço específicas em sua organização. Para obter mais detalhes de cenário e política, consulte Configure Azure AD sign in behavior for an application by using a Home Realm Discovery policy, well as Sign-in to Azure Active Directory using email as an alternate login ID.

Herda de stsPolicy.

Métodos

Método	Tipo de retorno	Descrição
Criar homeRealmDiscoveryPolicy	homeRealmDiscoveryPolicy	Crie um objeto homeRealmDiscoveryPolicy.
Obter homeRealmDiscoveryPolicy	homeRealmDiscoveryPolicy	Leia propriedades e relações de um objeto homeRealmDiscoveryPolicy.
Listar homeRealmDiscoveryPolicies	homeRealmDiscoveryPolicy	Ler propriedades e relações de objetos homeRealmDiscoveryPolicies.
Atualizar homeRealmDiscoveryPolicy	Nenhum	Atualize um objeto homeRealmDiscoveryPolicy.
Excluir homeRealmDiscoveryPolicy	Nenhum	Exclua um objeto homeRealmDiscoveryPolicy.
Lista appliesTo	Coleção directoryObject	Obter a lista de directoryObjects aos qual essa política foi aplicada.
Atribuir homeRealmDiscoveryPolicy	Nenhum	Atribua um objeto homeRealmDiscoveryPolicy a um objeto servicePrincipal .
Listar homeRealmDiscoveryPolicy atribuída	Conjunto homeRealmDiscoveryPolicy	Listar os objetos homeRealmDiscoveryPolicy atribuídos a um objeto servicePrincipal .
Remover homeRealmDiscoveryPolicy	Nenhum	Remova um objeto homeRealmDiscoveryPolicy de um objeto servicePrincipal .

Propriedades

Propriedade	Tipo	Descrição
id	Cadeia de caracteres	Identificador exclusivo dessa política. Somente leitura.
definition	String collection	Uma coleção de cadeias de caracteres que contém uma cadeia de caracteres JSON que define as regras e as configurações dessa política. Consulte Propriedades de uma definição de política de descoberta de domínio inicial para obter mais detalhes sobre o esquema JSON para essa propriedade. Obrigatório.
description	Cadeia de caracteres	Descrição dessa política.
displayName	Cadeia de caracteres	Nome de exibição para esta política. Obrigatório.
isOrganizationDefault	Boolean	Se definido como true, ativa essa política. Pode haver muitas políticas para o mesmo tipo de política, mas apenas uma pode ser ativada como o padrão da organização. Opcional, o valor padrão é false.

Propriedades de uma definição de política de descoberta de domínio inicial

As propriedades abaixo formam o objeto JSON que representa uma política de vida útil do token. Esse objeto JSON deve ser convertido em uma cadeia de caracteres com aspas que escapam para serem inseridas na propriedade definition . Um exemplo é mostrado abaixo no formato JSON:

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

Propriedade	Tipo	Descrição
AccelerateToFederatedDomain	Boolean	Definir como para true aceleração automática (ignorar descoberta de domínio inicial). Se true e houver apenas um domínio verificado e federado no locatário, os usuários serão levados diretamente para o provedor de identidade federado (como ADFS) para entrar. Se true e houver mais de um domínio verificado no locatário, PreferredDomain deve ser especificado. Opcional.
AllowCloudPasswordValidation	Boolean	De definida para true permitir que um aplicativo autenture um usuário federado apresentando credenciais de nome de usuário/senha diretamente para o ponto de extremidade Azure Active Directory token. Só funciona se a Sincronização de Hash de Senha estiver habilitada. Opcional.
AlternateIdLogin	Json	De definida para {\"Enabled\": true} permitir a logon do Azure AD usando email como uma ID de logon alternativa. Só funciona quando IsOrganizationDefault é definido como true. Opcional.
PreferredDomain	Cadeia de caracteres	Especifica um domínio para acelerar a login. Ele pode ser omitido se o locatário tiver apenas um domínio federado. Se for omitido e houver mais de um domínio federado verificado, essa política não terá efeito. Obrigatório se AccelerateToFederatedDomain for true.

Relações

Relação	Tipo	Descrição
appliesTo	Coleção directoryObject	A coleção directoryObject à qual essa política foi aplicada. Somente leitura.

Representação JSON

Veja a seguir uma representação JSON do recurso.

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