mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-08 20:37:48 +00:00
9269e86172
* added new oauth2 flow and description * renamed authentication to make more sense' by github action: 5967546682
40 lines
1.1 KiB
YAML
40 lines
1.1 KiB
YAML
post:
|
|
operationId: testSourceConnection
|
|
tags:
|
|
- Sources
|
|
summary: Check connection for source connector.
|
|
description: >-
|
|
This endpoint validates that the configured credentials are valid and will properly authenticate with the source
|
|
identified by the sourceId path parameter.
|
|
|
|
A token with ORG_ADMIN authority is required to call this API.
|
|
security:
|
|
- UserContextAuth: [idn:source-connector:manage]
|
|
parameters:
|
|
- in: path
|
|
name: sourceId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
description: The ID of the Source.
|
|
example: cef3ee201db947c5912551015ba0c679
|
|
responses:
|
|
'200':
|
|
description: The result of checking connection to the source connector with response from it.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/StatusResponse.yaml'
|
|
'400':
|
|
$ref: '../../v3/responses/400.yaml'
|
|
'401':
|
|
$ref: '../../v3/responses/401.yaml'
|
|
'403':
|
|
$ref: '../../v3/responses/403.yaml'
|
|
'404':
|
|
$ref: '../../v3/responses/404.yaml'
|
|
'429':
|
|
$ref: '../../v3/responses/429.yaml'
|
|
'500':
|
|
$ref: '../../v3/responses/500.yaml'
|