Справочник API публикуется на английском языке.
Test machine sign-in against the provider and server, then turn the connection on
POST
/api/tool-connections/{connectionId}/machine-sign-in/testPersonal API keyAgent API keyConsole session
Test machine sign-in against the provider and server, then turn the connection on.
Авторизация
Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Как работают ключи.
Параметры пути
connectionIdstringОбязательныйThe connection's id.
Тело запроса
application/json · обязательно
clientIdstringНеобязательный
1–4096 charactersclientSecretstringНеобязательный
1–16384 charactersscopesstringНеобязательный
at most 2048 charactersОтветы
200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).
Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.