La référence de l'API est publiée en anglais.

Start OAuth sign-in for a tool connection

POST/api/tools/oauth/{connectionId}/start
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

Start OAuth sign-in for a tool connection.

Autorisation

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. Fonctionnement des clés.

Paramètres de chemin

connectionIdstringObligatoireThe connection's id.

Corps de la requête

application/json · obligatoire

workspaceServicesobjectFacultatif
workspaceServices.gmailstringFacultatifone of: "read", "write"
workspaceServices.drivestringFacultatifone of: "read", "write"
workspaceServices.calendarstringFacultatifone of: "read", "write"
asCurrentUserbooleanFacultatif
asAgentIdstring (uuid)Facultatif
interactionIdstring (uuid)Facultatif

Réponses

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.

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Connectors