synchronizationJob: validateCredentials

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.

Valide se as credenciais são válidas no locatário para um synchronizationJob.

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet
✅ ✅ ✅ ✅

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) Synchronization.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application Application.ReadWrite.OwnedBy Synchronization.ReadWrite.All

Importante

Para acesso delegado usando contas corporativas ou de estudante, o usuário conectado deve ser proprietário ou membro do grupo ou ser atribuído a uma função do Microsoft Entra com suporte ou uma função personalizada que conceda as permissões necessárias para esta operação. Esta operação dá suporte às seguintes funções internas, que fornecem apenas o menor privilégio necessário:

  • Administrador de Aplicativos
  • Administrador de Aplicativos de Nuvem
  • Administrador de Identidade Híbrida – para configurar o Microsoft Entra Cloud Sync

Solicitação HTTP

POST /servicePrincipals/{id}/synchronization/jobs/{id}/validateCredentials

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.

Corpo da solicitação

Forneça um objeto JSON com os seguintes parâmetros no corpo da solicitação.

Parâmetro Tipo Descrição
useSavedCredentials Booliano Quando true, o parâmetro será ignorado credentials e as credenciais salvas anteriormente (se houver) serão validadas.
credenciais coleção synchronizationSecretKeyStringValuePair Credenciais a validar. Ignorado quando o useSavedCredentials parâmetro é true.
templateId Cadeia de caracteres Define as configurações padrão para a configuração de provisionamento.

Resposta

Se a validação for bem-sucedida, esse método retornará um código de 204, No Content resposta. Ele não retorna nada no corpo da resposta.

Exemplo

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/beta/servicePrincipals/{id}/synchronization/jobs/{id}/validateCredentials
Content-type: application/json

{
  "credentials": [
    {
      "key": "UserName",
      "value": "user@domain.com"
    },
    {
      "key": "Password",
      "value": "password-value"
    }
  ]
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content