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 Cache Warm / Warm Go Module and Build Cache (push) Failing after 2s
Server CI Nightly Race / Build Environment (push) Failing after 1s
352 lines
9.9 KiB
YAML
352 lines
9.9 KiB
YAML
/api/v4/bots:
|
|
post:
|
|
tags:
|
|
- bots
|
|
summary: Create a bot
|
|
description: |
|
|
Create a new bot account on the system. Username is required.
|
|
##### Permissions
|
|
Must have `create_bot` permission.
|
|
__Minimum server version__: 5.10
|
|
operationId: CreateBot
|
|
requestBody:
|
|
description: Bot to be created
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
required:
|
|
- username
|
|
properties:
|
|
username:
|
|
type: string
|
|
display_name:
|
|
type: string
|
|
description:
|
|
type: string
|
|
responses:
|
|
"201":
|
|
description: Bot creation successful
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/Bot"
|
|
"400":
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/components/responses/Forbidden"
|
|
get:
|
|
tags:
|
|
- bots
|
|
summary: Get bots
|
|
description: >
|
|
Get a page of a list of bots.
|
|
|
|
##### Permissions
|
|
|
|
Must have `read_bots` permission for bots you are managing, and `read_others_bots` permission for bots others are managing.
|
|
|
|
__Minimum server version__: 5.10
|
|
operationId: GetBots
|
|
parameters:
|
|
- name: page
|
|
in: query
|
|
description: The page to select.
|
|
schema:
|
|
type: integer
|
|
default: 0
|
|
- name: per_page
|
|
in: query
|
|
description: The number of users per page.
|
|
schema:
|
|
type: integer
|
|
default: 60
|
|
- name: include_deleted
|
|
in: query
|
|
description: If deleted bots should be returned.
|
|
schema:
|
|
type: boolean
|
|
- name: only_orphaned
|
|
in: query
|
|
description: When true, only orphaned bots will be returned. A bot is considered
|
|
orphaned if its owner has been deactivated.
|
|
schema:
|
|
type: boolean
|
|
responses:
|
|
"200":
|
|
description: Bot page retrieval successful
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Bot"
|
|
"400":
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/components/responses/Forbidden"
|
|
"/api/v4/bots/{bot_user_id}":
|
|
put:
|
|
tags:
|
|
- bots
|
|
summary: Patch a bot
|
|
description: >
|
|
Partially update a bot by providing only the fields you want to update.
|
|
Omitted fields will not be updated. The fields that can be updated are
|
|
defined in the request body, all other provided fields will be ignored.
|
|
|
|
##### Permissions
|
|
|
|
Must have `manage_bots` permission.
|
|
|
|
__Minimum server version__: 5.10
|
|
operationId: PatchBot
|
|
parameters:
|
|
- name: bot_user_id
|
|
in: path
|
|
description: Bot user ID
|
|
required: true
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
description: Bot to be created
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
required:
|
|
- username
|
|
properties:
|
|
username:
|
|
type: string
|
|
display_name:
|
|
type: string
|
|
description:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Bot patch successful
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/Bot"
|
|
"400":
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/components/responses/Forbidden"
|
|
get:
|
|
tags:
|
|
- bots
|
|
summary: Get a bot
|
|
description: >
|
|
Get a bot specified by its bot id.
|
|
|
|
##### Permissions
|
|
|
|
Must have `read_bots` permission for bots you are managing, and `read_others_bots` permission for bots others are managing.
|
|
|
|
__Minimum server version__: 5.10
|
|
operationId: GetBot
|
|
parameters:
|
|
- name: bot_user_id
|
|
in: path
|
|
description: Bot user ID
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- name: include_deleted
|
|
in: query
|
|
description: If deleted bots should be returned.
|
|
schema:
|
|
type: boolean
|
|
responses:
|
|
"200":
|
|
description: Bot successfully retrieved.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/Bot"
|
|
"400":
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/components/responses/Forbidden"
|
|
"/api/v4/bots/{bot_user_id}/disable":
|
|
post:
|
|
tags:
|
|
- bots
|
|
summary: Disable a bot
|
|
description: |
|
|
Disable a bot.
|
|
##### Permissions
|
|
Must have `manage_bots` permission.
|
|
__Minimum server version__: 5.10
|
|
operationId: DisableBot
|
|
parameters:
|
|
- name: bot_user_id
|
|
in: path
|
|
description: Bot user ID
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Bot successfully disabled.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/Bot"
|
|
"400":
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/components/responses/Forbidden"
|
|
"/api/v4/bots/{bot_user_id}/enable":
|
|
post:
|
|
tags:
|
|
- bots
|
|
summary: Enable a bot
|
|
description: |
|
|
Enable a bot.
|
|
##### Permissions
|
|
Must have `manage_bots` permission.
|
|
__Minimum server version__: 5.10
|
|
operationId: EnableBot
|
|
parameters:
|
|
- name: bot_user_id
|
|
in: path
|
|
description: Bot user ID
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Bot successfully enabled.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/Bot"
|
|
"400":
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/components/responses/Forbidden"
|
|
"/api/v4/bots/{bot_user_id}/assign/{user_id}":
|
|
post:
|
|
tags:
|
|
- bots
|
|
summary: Assign a bot to a user
|
|
description: |
|
|
Assign a bot to a specified user.
|
|
##### Permissions
|
|
Must have `manage_bots` permission.
|
|
__Minimum server version__: 5.10
|
|
operationId: AssignBot
|
|
parameters:
|
|
- name: bot_user_id
|
|
in: path
|
|
description: Bot user ID
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- name: user_id
|
|
in: path
|
|
description: The user ID to assign the bot to.
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Bot successfully assigned.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/Bot"
|
|
"400":
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/components/responses/Forbidden"
|
|
"/api/v4/bots/{bot_user_id}/convert_to_user":
|
|
post:
|
|
tags:
|
|
- bots
|
|
- users
|
|
summary: Convert a bot into a user
|
|
description: |
|
|
Convert a bot into a user.
|
|
|
|
__Minimum server version__: 5.26
|
|
|
|
##### Permissions
|
|
Must have `manage_system` permission.
|
|
operationId: ConvertBotToUser
|
|
parameters:
|
|
- name: bot_user_id
|
|
in: path
|
|
description: Bot user ID
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- name: set_system_admin
|
|
in: query
|
|
description: Whether to give the user the system admin role.
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
email:
|
|
type: string
|
|
username:
|
|
type: string
|
|
password:
|
|
type: string
|
|
first_name:
|
|
type: string
|
|
last_name:
|
|
type: string
|
|
nickname:
|
|
type: string
|
|
locale:
|
|
type: string
|
|
position:
|
|
type: string
|
|
props:
|
|
type: object
|
|
notify_props:
|
|
$ref: "#/components/schemas/UserNotifyProps"
|
|
description: Data to be used in the user creation
|
|
required: true
|
|
responses:
|
|
"200":
|
|
description: Bot successfully converted
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/StatusOK"
|
|
"400":
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/components/responses/Forbidden"
|
|
"404":
|
|
$ref: "#/components/responses/NotFound"
|