synchronizationJob: validateCredentials

Пространство имен: microsoft.graph

Убедитесь, что учетные данные действительны в клиенте.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба	Правительство США L4	Правительство США L5 (DOD)	Китай управляется 21Vianet
✅	✅	✅	❌

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения	Разрешения с наименьшими привилегиями	Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись)	Synchronization.ReadWrite.All	Недоступно.
Делегированные (личная учетная запись Майкрософт)	Не поддерживается.	Не поддерживается.
Приложение	Application.ReadWrite.OwnedBy	Synchronization.ReadWrite.All

Чтобы настроить подготовку приложений или подготовку на основе управления персоналом, вызывающему пользователю также должна быть назначена по крайней мере роль каталога"Администратор приложений" или "Администратор облачных приложений".

Чтобы настроить облачную синхронизацию Microsoft Entra, вызывающему пользователю также должна быть назначена по крайней мере роль каталога гибридного администратора удостоверений.

HTTP-запрос

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

Заголовки запросов

Имя	Описание
Авторизация	Bearer {code}

Текст запроса

В тексте запроса предоставьте JSON-объект с указанными ниже параметрами.

Параметр	Тип	Описание
useSavedCredentials	Логический	Если trueзадано credentials значение , параметр будет игнорироваться, а ранее сохраненные учетные данные (если таковые есть) будут проверены.
Учетные данные	Коллекция synchronizationSecretKeyStringValuePair	Учетные данные для проверки. Игнорируется, useSavedCredentials если параметр имеет значение true.

Отклик

Если проверка прошла успешно, этот метод возвращает 204, No Content код ответа. Он не возвращает ничего в теле ответа.

Пример

Запрос

Ниже показан пример запроса.

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

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по 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);

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Отклик

Ниже приводится пример отклика.

HTTP/1.1 204 No Content