synchronizationJob: validateCredentials
Namespace: microsoft.graph
Validate that the credentials are valid in the tenant.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ❌ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | Synchronization.ReadWrite.All | Not available. |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | Application.ReadWrite.OwnedBy | Synchronization.ReadWrite.All |
To configure application provisioning or HR-driven provisioning, the calling user must also be assigned at least the Application Administrator or Cloud Application Administrator directory role.
To configure Microsoft Entra Cloud Sync, the calling user must also be assigned at least the Hybrid Identity Administrator directory role.
HTTP request
POST /servicePrincipals/{id}/synchronization/jobs/{id}/validateCredentials
Request headers
Name | Description |
---|---|
Authorization | Bearer {code} |
Request body
In the request body, provide a JSON object with the following parameters.
Parameter | Type | Description |
---|---|---|
useSavedCredentials | Boolean | When true , the credentials parameter will be ignored and the previously saved credentials (if any) will be validated instead. |
credentials | synchronizationSecretKeyStringValuePair collection | Credentials to validate. Ignored when the useSavedCredentials parameter is true . |
Response
If validation is successful, this method returns a 204, No Content
response code. It doesn't return anything in the response body.
Example
Request
The following example shows a request.
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" }
]
}
Response
The following example shows the response.
HTTP/1.1 204 No Content
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for