240db4e2a7
Some checks failed
Server CI / Postgres (shard 0) (push) Has been skipped
Server CI / Postgres (shard 3) (push) Has been skipped
BuildEnv Docker Image / build-image (push) Failing after 4s
BuildEnv Docker Image / build-image-fips (push) Failing after 4s
Migration Review & Release Notes / Generate migration review & release notes (push) Failing after 3s
Server CI / Build Environment (push) Failing after 3s
Server CI / Postgres (shard 1) (push) Has been skipped
Tools CI / check-style (mattermost-govet) (push) Failing after 4s
Server CI / Postgres (shard 2) (push) Has been skipped
Tools CI / check-style (mmgotool) (push) Failing after 3s
Server CI / Elasticsearch v8 Compatibility (push) Has been skipped
Server CI / OpenSearch v2 Compatibility (push) Has been skipped
Server CI / Postgres FIPS (shard 0) (push) Has been skipped
Tools CI / Test (mattermost-govet) (push) Failing after 3s
Server CI / Postgres FIPS (shard 1) (push) Has been skipped
Server CI / Postgres FIPS (shard 2) (push) Has been skipped
Tools CI / Test (mmgotool) (push) Failing after 3s
Server CI / Postgres FIPS (shard 3) (push) Has been skipped
Server CI / Run mmctl tests (push) Has been skipped
Server CI / Run mmctl tests (FIPS) (push) Has been skipped
Server CI / Merge Postgres Test Results (push) Has been skipped
Server CI / Merge Postgres FIPS Test Results (push) Has been skipped
Server CI / Check backport migrations (push) Has been skipped
Server CI / Check generated files (push) Has been skipped
Server CI / check-style (push) Has been skipped
Server CI / Vet API (push) Has been skipped
Server CI / Build mattermost server app (push) Has been skipped
Server CI / Server CI Complete (push) Failing after 2s
Server CI / Server CI Artifacts (push) Has been skipped
Server CI / Sentry Upload (push) Has been skipped
Server CI / Server CI Report (push) Failing after 5m1s
Server CI Nightly Race / Race Detector (push) Has been skipped
CodeQL / Analyze (go) (push) Has been cancelled
CodeQL / Analyze (javascript) (push) Has been cancelled
Webapp CI Cache Warm / Warm Webapp node_modules Cache (push) Has been cancelled
E2E CI Cache Warm / Warm E2E npm Registry Cache (push) Has been cancelled
API / build (push) Has been cancelled
Web App CI / check-types (push) Has been cancelled
Web App CI / check-lint (push) Has been cancelled
Web App CI / check-i18n (push) Has been cancelled
Web App CI / check-external-links (push) Has been cancelled
Web App CI / test (platform) (push) Has been cancelled
Web App CI / test (mattermost-redux) (push) Has been cancelled
Web App CI / test (channels shard 1/4) (push) Has been cancelled
Web App CI / test (channels shard 2/4) (push) Has been cancelled
Web App CI / test (channels shard 3/4) (push) Has been cancelled
Web App CI / test (channels shard 4/4) (push) Has been cancelled
Web App CI / upload-coverage (push) Has been cancelled
Web App CI / build (push) Has been cancelled
YAML Lint / yamllint (push) Has been cancelled
Push mirrored docker images / cd/Push mirrored docker images (push) Has been cancelled
docs-cd / Build and deploy docs (push) Has been cancelled
Docs CI / build (push) Has been cancelled
E2E Cache Warm: Cypress deps / Warm Cypress deps cache (push) Has been cancelled
Scorecards supply-chain security / Scorecard analysis (push) Has been cancelled
Server CI Weekly / Postgres FIPS (push) Has been skipped
Server CI Weekly / Run mmctl tests (FIPS) (push) Has been skipped
Server CI Weekly / Postgres with binary parameters (push) Has been skipped
Server CI Weekly / Build Environment (push) Failing after 1s
Server CI Nightly Race / Build Environment (push) Failing after 1s
Server CI Cache Warm / Warm Go Module and Build Cache (push) Failing after 2s
236 lines
7.5 KiB
YAML
236 lines
7.5 KiB
YAML
/api/v4/oauth/outgoing_connections:
|
|
get:
|
|
tags:
|
|
- oauth
|
|
- outgoing_connections
|
|
- outgoing_oauth_connections
|
|
summary: List all connections
|
|
description: >
|
|
List all outgoing OAuth connections.
|
|
|
|
__Minimum server version__: 9.6
|
|
operationId: ListOutgoingOAuthConnections
|
|
parameters:
|
|
- name: team_id
|
|
in: query
|
|
description: Current Team ID in integrations backstage
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Successfully fetched outgoing OAuth connections
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/OutgoingOAuthConnectionGetItem"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"500":
|
|
$ref: "#/components/responses/InternalServerError"
|
|
"501":
|
|
$ref: "#/components/responses/NotImplemented"
|
|
post:
|
|
tags:
|
|
- oauth
|
|
- outgoing_connections
|
|
- outgoing_oauth_connections
|
|
summary: Create a connection
|
|
description: >
|
|
Create an outgoing OAuth connection.
|
|
|
|
__Minimum server version__: 9.6
|
|
operationId: CreateOutgoingOAuthConnection
|
|
parameters:
|
|
- name: team_id
|
|
in: query
|
|
description: Current Team ID in integrations backstage
|
|
required: true
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
description: Outgoing OAuth connection to create
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/OutgoingOAuthConnectionPostItem"
|
|
responses:
|
|
"201":
|
|
description: Successfully created outgoing OAuth connection
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/OutgoingOAuthConnectionGetItem"
|
|
"400":
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"500":
|
|
$ref: "#/components/responses/InternalServerError"
|
|
"501":
|
|
$ref: "#/components/responses/NotImplemented"
|
|
/api/v4/oauth/outgoing_connections/{outgoing_oauth_connection_id}:
|
|
get:
|
|
tags:
|
|
- oauth
|
|
- outgoing_connections
|
|
- outgoing_oauth_connections
|
|
summary: Get a connection
|
|
description: >
|
|
Retrieve an outgoing OAuth connection.
|
|
|
|
__Minimum server version__: 9.6
|
|
operationId: GetOutgoingOAuthConnection
|
|
parameters:
|
|
- name: outgoing_oauth_connection_id
|
|
in: path
|
|
description: Outgoing OAuth connection ID
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- name: team_id
|
|
in: query
|
|
description: Current Team ID in integrations backstage
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Successfully fetched outgoing OAuth connection
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/OutgoingOAuthConnectionGetItem"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"500":
|
|
$ref: "#/components/responses/InternalServerError"
|
|
"501":
|
|
$ref: "#/components/responses/NotImplemented"
|
|
put:
|
|
tags:
|
|
- oauth
|
|
- outgoing_connections
|
|
- outgoing_oauth_connections
|
|
summary: Update a connection
|
|
description: >
|
|
Update an outgoing OAuth connection.
|
|
|
|
__Minimum server version__: 9.6
|
|
operationId: UpdateOutgoingOAuthConnection
|
|
parameters:
|
|
- name: outgoing_oauth_connection_id
|
|
in: path
|
|
description: Outgoing OAuth connection ID
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- name: team_id
|
|
in: query
|
|
description: Current Team ID in integrations backstage
|
|
required: true
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
description: Outgoing OAuth connection to update
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/OutgoingOAuthConnectionPostItem"
|
|
responses:
|
|
"200":
|
|
description: Successfully updated outgoing OAuth connection
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/OutgoingOAuthConnectionGetItem"
|
|
"400":
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"404":
|
|
$ref: "#/components/responses/NotFound"
|
|
"500":
|
|
$ref: "#/components/responses/InternalServerError"
|
|
"501":
|
|
$ref: "#/components/responses/NotImplemented"
|
|
delete:
|
|
tags:
|
|
- oauth
|
|
- outgoing_connections
|
|
- outgoing_oauth_connections
|
|
summary: Delete a connection
|
|
description: >
|
|
Delete an outgoing OAuth connection.
|
|
|
|
__Minimum server version__: 9.6
|
|
operationId: DeleteOutgoingOAuthConnection
|
|
parameters:
|
|
- name: outgoing_oauth_connection_id
|
|
in: path
|
|
description: Outgoing OAuth connection ID
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- name: team_id
|
|
in: query
|
|
description: Current Team ID in integrations backstage
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Successfully deleted outgoing OAuth connection
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"404":
|
|
$ref: "#/components/responses/NotFound"
|
|
"500":
|
|
$ref: "#/components/responses/InternalServerError"
|
|
"501":
|
|
$ref: "#/components/responses/NotImplemented"
|
|
/api/v4/oauth/outgoing_connections/validate:
|
|
post:
|
|
tags:
|
|
- oauth
|
|
- outgoing_connections
|
|
- outgoing_oauth_connections
|
|
summary: Validate a connection configuration
|
|
description: >
|
|
Validate an outgoing OAuth connection. If an id is provided in the payload, and no client secret is provided, then the stored client secret is implicitly used for the validation.
|
|
|
|
__Minimum server version__: 9.6
|
|
operationId: ValidateOutgoingOAuthConnection
|
|
parameters:
|
|
- name: team_id
|
|
in: query
|
|
description: Current Team ID in integrations backstage
|
|
required: true
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
description: Outgoing OAuth connection to validate
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/OutgoingOAuthConnectionPostItem"
|
|
responses:
|
|
"200":
|
|
description: The connection configuration is valid.
|
|
"400":
|
|
description: The connection configuration is invalid.
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"404":
|
|
$ref: "#/components/responses/NotFound"
|
|
"500":
|
|
$ref: "#/components/responses/InternalServerError"
|
|
"501":
|
|
$ref: "#/components/responses/NotImplemented"
|
|
"502":
|
|
description: The connection configuration may be valid, but the server is unable to validate it upstream.
|
|
$ref: "#/components/responses/BadGateway"
|