synchronizationJob: validateCredentials

Espacio de nombres: microsoft.graph

Valide que las credenciales son válidas en el inquilino.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global	Gobierno de EE. UU. L4	Us Government L5 (DOD)	China operada por 21Vianet
✅	✅	✅	❌

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso	Permisos con privilegios mínimos	Permisos con privilegios más altos
Delegado (cuenta profesional o educativa)	Synchronization.ReadWrite.All	No disponible.
Delegado (cuenta personal de Microsoft)	No admitida.	No admitida.
Aplicación	Application.ReadWrite.OwnedBy	Synchronization.ReadWrite.All

Importante

En escenarios delegados con cuentas profesionales o educativas, el usuario que ha iniciado sesión debe ser propietario o miembro del grupo o tener asignado un rol de Microsoft Entra compatible o un rol personalizado con un permiso de rol admitido. Se admiten los siguientes roles con privilegios mínimos para esta operación.

• Administrador de la aplicación
• Administrador de aplicaciones en la nube
• Administrador de identidades híbridas: para configurar Microsoft Entra Cloud Sync

Solicitud HTTP

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

Encabezados de solicitud

Nombre	Descripción
Authorization	{token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione un objeto JSON con los siguientes parámetros.

Parámetro	Tipo	Descripción
useSavedCredentials	Booleano	Cuando true, se omitirá el credentials parámetro y se validarán las credenciales guardadas anteriormente (si las hubiera).
credenciales	synchronizationSecretKeyStringValuePair (colección)	Credenciales que se van a validar. Se omite cuando el useSavedCredentials parámetro es true.

Respuesta

Si la validación se realiza correctamente, este método devuelve un código de 204, No Content respuesta. No devuelve nada en el cuerpo de la respuesta.

Ejemplo

Solicitud

En el ejemplo siguiente se muestra la solicitud.

HTTP

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

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

CLI

mgc service-principals synchronization jobs validate-credentials-by-id post --service-principal-id {servicePrincipal-id} --synchronization-job-id {synchronizationJob-id} --body '{\
    credentials: [ \
        { key: "UserName", value: "user@domain.com" },\
        { key: "Password", value: "password-value" }\
    ]\
}\
'

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const validateCredentials = {
    credentials: [ 
        { key: 'UserName', value: 'user@domain.com' },
        { key: 'Password', value: 'password-value' }
    ]
};

await client.api('/servicePrincipals/{id}/synchronization/jobs/{id}/validateCredentials')
	.post(validateCredentials);

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Respuesta

En el ejemplo siguiente se muestra la respuesta.

HTTP/1.1 204 No Content