synchronizationJob: validateCredentials

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Validate that the credentials are valid in the tenant.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	Directory.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	Application.ReadWrite.OwnedBy, Directory.ReadWrite.All

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 does not return anything in the response body.

Example

Request

The following is an example of the request.

HTTP

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" }
    ]
}

C#

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var credentials = new List<SynchronizationSecretKeyStringValuePair>()
{
	new SynchronizationSecretKeyStringValuePair
	{
		Key = SynchronizationSecret.UserName,
		Value = "user@domain.com"
	},
	new SynchronizationSecretKeyStringValuePair
	{
		Key = SynchronizationSecret.Password,
		Value = "password-value"
	}
};

await graphClient.ServicePrincipals["{servicePrincipal-id}"].Synchronization.Jobs["{synchronizationJob-id}"]
	.ValidateCredentials(null,null,null,credentials)
	.Request()
	.PostAsync();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

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')
	.version('beta')
	.post(validateCredentials);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

LinkedList<SynchronizationSecretKeyStringValuePair> credentialsList = new LinkedList<SynchronizationSecretKeyStringValuePair>();
SynchronizationSecretKeyStringValuePair credentials = new SynchronizationSecretKeyStringValuePair();
credentials.key = SynchronizationSecret.USER_NAME;
credentials.value = "user@domain.com";

credentialsList.add(credentials);
SynchronizationSecretKeyStringValuePair credentials1 = new SynchronizationSecretKeyStringValuePair();
credentials1.key = SynchronizationSecret.PASSWORD;
credentials1.value = "password-value";

credentialsList.add(credentials1);

graphClient.servicePrincipals("{id}").synchronization().jobs("{id}")
	.validateCredentials(SynchronizationJobValidateCredentialsParameterSet
		.newBuilder()
		.withApplicationIdentifier(null)
		.withTemplateId(null)
		.withUseSavedCredentials(null)
		.withCredentials(credentialsList)
		.build())
	.buildRequest()
	.post();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following is an example of the response.

HTTP/1.1 204 No Content