v68

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0170379386.9 KB
Tools

Start the OAuth authorization flow for a tool server.

Initiates the third-party OAuth flow for the specified tool server and returns the authorization URL that the client should navigate the end user to. After the OAuth callback completes, the user's browser is redirected back to returnUrl with query parameters indicating the result.

returnUrl must match the tenant's configured return URL allowlist; otherwise the request is rejected with 400.

post/rest/api/v1/tool-servers/{serverId}/auth

Request body

returnUrlstring required

URL to redirect the end user's browser back to after the OAuth flow completes. Must be present in the tenant's configured return URL allowlist.

Response

Successful operation

authorizationUrlstring required

URL that the client should navigate the end user to in order to begin the OAuth flow. After the user consents, control returns to returnUrl from the request.