homeRealmDiscovery Tipo de recursoPolicy

Artigo
07/16/2024

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 Versão.

Representa uma política para controlar o comportamento de autenticação do Microsoft Entra para utilizadores federados, em particular para restrições de autenticação automática e de autenticação de utilizadores em domínios federados. Pode definir homeRealmDiscoveryPolicy para todos os principais de serviço na sua organização ou para principais de serviço específicos na sua organização. Para obter mais detalhes sobre o cenário e a política, consulte Configurar o comportamento de início de sessão do Microsoft Entra para uma aplicação com uma política de Deteção de Realm Base e Iniciar sessão no Microsoft Entra ID através do e-mail como um ID de início de sessão alternativo.

Herda de stsPolicy.

Métodos

Método	Tipo de retorno	Descrição
List	homeRealmDiscoveryPolicy	Ler propriedades e relações dos objetos homeRealmDiscoveryPolicies.
Create	homeRealmDiscoveryPolicy	Crie um objeto homeRealmDiscoveryPolicy.
Get	homeRealmDiscoveryPolicy	Ler propriedades e relações de um objeto homeRealmDiscoveryPolicy.
Atualizar	Nenhum(a)	Atualizar um objeto homeRealmDiscoveryPolicy.
Delete	Nenhum	Elimine um objeto homeRealmDiscoveryPolicy.
A lista aplica-se a	Coleção directoryObject	Obtenha a lista de directoryObjects aos quais esta política foi aplicada.
Atribuir ao principal de serviço	Nenhum	Atribua um objeto homeRealmDiscoveryPolicy a um objeto servicePrincipal .
Lista atribuída ao principal de serviço	Conjunto homeRealmDiscoveryPolicy	Liste os objetos homeRealmDiscoveryPolicy atribuídos a um objeto servicePrincipal .
Anular a atribuição do principal de serviço	Nenhum	Remova um objeto homeRealmDiscoveryPolicy de um objeto servicePrincipal .

Propriedades

Propriedade	Tipo	Descrição
id	Cadeia de caracteres	Identificador exclusivo para esta política. Somente leitura.
definição	String collection	Uma coleção de cadeias que contém uma cadeia JSON que define as regras e definições para esta política. Para obter mais informações sobre o esquema JSON para esta propriedade, veja Properties of a home realm discovery policy definition (Propriedades de uma definição de política de deteção de realm doméstico). Obrigatório.
description	Cadeia de caracteres	Descrição para esta política.
displayName	Cadeia de caracteres	Nome a apresentar para esta política. Obrigatório.
isOrganizationDefault	Booliano	Se definido como `true`, ativa esta política. Podem existir muitas políticas para o mesmo tipo de política, mas apenas uma pode ser ativada como a predefinição da organização. Opcional, o valor predefinido é `false`.

Propriedades de uma definição de política de deteção de realm raiz

O objeto seguinte mostra as propriedades que formam o objeto JSON para uma definição de política de duração de token. Este objeto JSON tem de ser convertido numa cadeia com aspas escapadas para ser inserido na propriedade de definição , conforme mostrado no exemplo seguinte.

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

Propriedade	Tipo	Descrição
AccelerateToFederatedDomain	Booliano	Defina como `true` para a recuperação automática (ignorar a deteção de realm doméstico). Se `true` e existir apenas um domínio verificado e federado no inquilino, os utilizadores serão diretamente levados para o fornecedor de identidade federado (como o ADFS) para iniciar sessão. Se `true` e existir mais do que um domínio verificado no inquilino, preferredDomain tem de ser especificado. Opcional.
AllowCloudPasswordValidation	Booliano	Defina como `true` para permitir que uma aplicação autentique um utilizador federado ao apresentar credenciais de nome de utilizador/palavra-passe diretamente no ponto final do token do Microsoft Entra. Só funciona se a Sincronização hash de palavras-passe estiver ativada. Opcional.
AlternateIdLogin	Json	Defina como para `{\"Enabled\": true}` permitir o início de sessão do Microsoft Entra utilizando o e-mail como um ID de início de sessão alternativo. Só funciona quando IsOrganizationDefault está definido como `true`. Opcional.
PreferredDomain	Cadeia de caracteres	Especifica um domínio para acelerar o início de sessão. Pode ser omitido se o inquilino tiver apenas um domínio federado. Se for omitido e existir mais do que um domínio federado verificado, esta política não tem qualquer efeito. Necessário se AccelerateToFederatedDomain for `true`.

Relações

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

Representação JSON

A representação JSON seguinte mostra o tipo de recurso.

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

Partilhar via