diff --git a/integrations.yaml b/integrations.yaml
index db7374c..f6c8720 100644
--- a/integrations.yaml
+++ b/integrations.yaml
@@ -991,620 +991,8 @@ paths:
value:
success: false
error: No integration found.
- /api/v1/webdav.getMyAccounts:
- get:
- tags:
- - WebDAV
- summary: Get WebDAV Accounts
- description: |-
- Retrieves the user's WebDAV accounts.
-
- ### Changelog
- | Version | Description |
- | ---------------- | ------------|
- |2.4.0 | Added |
- operationId: get-api-v1-webdav.getMyAccounts
- parameters:
- - $ref: '#/components/parameters/X-Auth-Token'
- - $ref: '#/components/parameters/X-User-Id'
- responses:
- '200':
- description: ''
- content:
- application/json:
- schema:
- type: object
- properties:
- accounts:
- type: array
- items:
- type: object
- properties:
- _id:
- type: string
- server_url:
- type: string
- username:
- type: string
- name:
- type: string
- success:
- type: boolean
- examples:
- Success Example:
- value:
- accounts:
- - _id: P3Gru7ocFCd4vpKEs
- server_url: 'http://localhost:8080/remote.php/webdav/'
- username: admin
- name: Webdav account
- success: true
- '401':
- $ref: '#/components/responses/authorizationError'
- /api/v1/webdav.removeWebdavAccount:
- post:
- tags:
- - WebDAV
- summary: Remove WebDAV Account
- description: Remove a specific WebDAV account.
- operationId: post-api-v1-webdav.removeWebdavAccount
- parameters:
- - $ref: '#/components/parameters/X-Auth-Token'
- - $ref: '#/components/parameters/X-User-Id'
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- accountId:
- type: string
- description: The WebDAV account ID that you want to remove.
- required:
- - accountId
- examples:
- Example 1:
- value:
- accountId: P3Gru7ocFCd4vpKEs
- responses:
- '200':
- description: ''
- content:
- application/json:
- schema:
- type: object
- properties:
- success:
- type: boolean
- '401':
- $ref: '#/components/responses/authorizationError'
- '400':
- description: Bad Request
- content:
- application/json:
- schema:
- type: object
- properties:
- success:
- type: boolean
- error:
- type: string
- errorType:
- type: string
- examples:
- Example 1:
- value:
- success: false
- error: 'must have required property ''accountId'' [invalid-params]'
- errorType: invalid-params
- /api/v1/oauth-apps.create:
- post:
- tags:
- - OAuth Apps
- summary: Create OAuth App
- description: 'Permission required: `manage-oauth-apps`'
- operationId: post-api-v1-oauth-apps.create
- parameters:
- - $ref: '#/components/parameters/X-Auth-Token'
- - $ref: '#/components/parameters/X-User-Id'
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- name:
- type: string
- description: Name of the app that you want to create.
- redirectUri:
- type: string
- description: The URL to redirect the OAuth app.
- active:
- type: boolean
- description: 'Whether the app will be active or not. Enter a boolean value, `true` or `false`.'
- required:
- - name
- - redirectUri
- - active
- examples:
- Example 1:
- value:
- name: test-oauth-app
- redirectUri: 'https://testuri.com'
- active: true
- responses:
- '200':
- description: ''
- content:
- application/json:
- schema:
- type: object
- properties:
- application:
- type: object
- properties:
- name:
- type: string
- redirectUri:
- type: string
- active:
- type: boolean
- clientId:
- type: string
- clientSecret:
- type: string
- _createdAt:
- type: string
- _updatedAt:
- type: string
- _createdBy:
- type: object
- properties:
- _id:
- type: string
- username:
- type: string
- _id:
- type: string
- success:
- type: boolean
- examples:
- Example 1:
- value:
- application:
- name: test-oauth-app
- redirectUri: 'https://testuri.com'
- active: true
- clientId: bN9D5TjY8Cv8GqWfE
- clientSecret: l3HAl0lSr2VaTYZVED6EabyhNzovS8Je2JYmbjNT-V1
- _createdAt: '2024-01-17T13:30:41.521Z'
- _updatedAt: '2024-01-17T13:30:41.521Z'
- _createdBy:
- _id: JFTcMhEAFbNPfnp49
- username: math.bar
- _id: 65a7d68142a7e12453052d56
- success: true
- '400':
- description: Bad Request
- content:
- application/json:
- schema:
- type: object
- properties:
- success:
- type: boolean
- error:
- type: string
- errorType:
- type: string
- examples:
- Example 1:
- value:
- success: false
- error: 'must have required property ''name'' [invalid-params]'
- errorType: invalid-params
- Example 2:
- value:
- success: false
- error: 'must have required property ''active'' [invalid-params]'
- errorType: invalid-params
- Example 3:
- value:
- success: false
- error: 'must have required property ''redirectUri'' [invalid-params]'
- errorType: invalid-params
- '401':
- $ref: '#/components/responses/authorizationError'
- /api/v1/oauth-apps.update:
- post:
- tags:
- - OAuth Apps
- summary: Update OAuth App
- description: 'Permission required: `manage-oauth-apps`'
- operationId: post-api-v1-oauth-apps.update
- parameters:
- - $ref: '#/components/parameters/X-Auth-Token'
- - $ref: '#/components/parameters/X-User-Id'
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- name:
- type: string
- description: Name of the app that you want to create.
- redirectUri:
- type: string
- description: The URL to redirect the OAuth app.
- active:
- type: boolean
- description: 'Whether the app will be active or not. Enter a boolean value, `true` or `false`.'
- appId:
- type: string
- description: The app ID.
- required:
- - name
- - redirectUri
- - active
- - appId
- examples:
- Example 1:
- value:
- name: test-oauth-app
- redirectUri: 'https://testuri.com'
- active: true
- responses:
- '200':
- description: ''
- content:
- application/json:
- schema:
- type: object
- properties:
- _id:
- type: string
- name:
- type: string
- redirectUri:
- type: string
- active:
- type: boolean
- clientId:
- type: string
- clientSecret:
- type: string
- _createdAt:
- type: string
- _updatedAt:
- type: string
- _createdBy:
- type: object
- properties:
- _id:
- type: string
- username:
- type: string
- _updatedBy:
- type: object
- properties:
- _id:
- type: string
- username:
- type: string
- success:
- type: boolean
- examples:
- Example 1:
- value:
- _id: 65a7d77142a7e12453052d59
- name: test-oauth-app2
- redirectUri: 'https://testuri2.com'
- active: false
- clientId: fxHAgLRjP3RswMe67
- clientSecret: QwIAYE1_8M02p-Js8SHZyTPg7HpJm-1ZtbjuSp8bXpP
- _createdAt: '2024-01-17T13:34:41.445Z'
- _updatedAt: '2024-01-17T13:37:16.966Z'
- _createdBy:
- _id: JFTcMhEAFbNPfnp49
- username: math.bar
- _updatedBy:
- _id: JFTcMhEAFbNPfnp49
- username: math.bar
- success: true
- '401':
- $ref: '#/components/responses/authorizationError'
- '400':
- description: Bad Request
- content:
- application/json:
- schema:
- type: object
- properties:
- success:
- type: boolean
- error:
- type: string
- errorType:
- type: string
- examples:
- Example 1:
- value:
- success: false
- error: 'must have required property ''name'' [invalid-params]'
- errorType: invalid-params
- Example 2:
- value:
- success: false
- error: 'must have required property ''active'' [invalid-params]'
- errorType: invalid-params
- Example 3:
- value:
- success: false
- error: 'must have required property ''redirectUri'' [invalid-params]'
- errorType: invalid-params
- Example 4:
- value:
- success: false
- error: 'must have required property ''appId'' [invalid-params]'
- errorType: invalid-params
- /api/v1/oauth-apps.list:
- get:
- tags:
- - OAuth Apps
- summary: Get List of OAuth Apps
- description: |-
- Permission required: `manage-oauth-apps`
- ### Changelog
- | Version | Description |
- | ---------------- | ------------|
- |2.4.0 | Added |
- operationId: get-api-v1-oauth-apps.list
- parameters:
- - $ref: '#/components/parameters/X-Auth-Token'
- - $ref: '#/components/parameters/X-User-Id'
- responses:
- '200':
- description: ''
- content:
- application/json:
- schema:
- type: object
- properties:
- oauthApps:
- type: array
- items:
- type: object
- properties:
- _id:
- type: string
- name:
- type: string
- active:
- type: boolean
- clientId:
- type: string
- clientSecret:
- type: string
- redirectUri:
- type: string
- _createdAt:
- type: string
- _createdBy:
- type: object
- properties:
- _id:
- type: string
- username:
- type: string
- _updatedAt:
- type: string
- success:
- type: boolean
- examples:
- Success Example:
- value:
- oauthApps:
- - _id: zapier
- name: Zapier
- active: true
- clientId: zapier
- clientSecret: RTK6TlndaCIolhQhZ7_KHIGOKj41RnlaOq_o-7JKwLr
- redirectUri: 'https://zapier.com/dashboard/auth/oauth/return/RocketChatDevAPI/'
- _createdAt: '2019-10-17T22:55:32.787Z'
- _createdBy:
- _id: system
- username: system
- _updatedAt: '2019-10-17T22:55:32.787Z'
- success: true
- '401':
- $ref: '#/components/responses/authorizationError'
- /api/v1/oauth-apps.get:
- get:
- tags:
- - OAuth Apps
- summary: Get OAuth App
- description: |-
- Retrieves an OAuth app by ID or client ID.
-
- Permission required: `manage-oauth-apps`. The endpoint can be accessed even without this permission, but sensitive information (such as client secrets) will be filtered out.
-
- ### Changelog
- | Version | Description |
- | ---------------- | ------------|
- |2.4.0 | Added |
- operationId: get-api-v1-oauth-apps.get
- parameters:
- - $ref: '#/components/parameters/X-Auth-Token'
- - $ref: '#/components/parameters/X-User-Id'
- - name: appId
- in: query
- description: |-
- The app ID. This value is required if `clientId` is not used.
-
- The parameter will stop being accepted from 7.0.0 (use the `clientId` or `_id` parameters instead).
- schema:
- type: string
- example: jn32kjnnd0943j4njk
- - name: clientId
- in: query
- description: The client ID. This value is required if `appId` is not used.
- schema:
- type: string
- example: nkn8jk67b8b99b78
- - name: _id
- in: query
- description: The app ID. This value is required if `clientId` is not used.
- schema:
- type: string
- responses:
- '200':
- description: ''
- content:
- application/json:
- schema:
- type: object
- properties:
- oauthApp:
- type: object
- properties:
- _id:
- type: string
- name:
- type: string
- active:
- type: boolean
- clientId:
- type: string
- clientSecret:
- type: string
- redirectUri:
- type: string
- _createdAt:
- type: string
- _createdBy:
- type: object
- properties:
- _id:
- type: string
- username:
- type: string
- _updatedAt:
- type: string
- success:
- type: boolean
- examples:
- Example 1:
- value:
- oauthApp:
- _id: zapier
- name: Zapier
- active: true
- clientId: zapier
- clientSecret: RTK6TlndaCIolhQhZ7_KHIGOKj41RnlaOq_o-7JKwLr
- redirectUri: 'https://zapier.com/dashboard/auth/oauth/return/RocketChatDevAPI/'
- _createdAt: '2019-10-17T22:55:32.787Z'
- _createdBy:
- _id: system
- username: system
- _updatedAt: '2019-10-17T22:55:32.787Z'
- success: true
- '401':
- $ref: '#/components/responses/authorizationError'
- '400':
- description: Bad Request
- content:
- application/json:
- schema:
- type: object
- properties:
- success:
- type: boolean
- error:
- type: string
- errorType:
- type: string
- examples:
- Example 1:
- value:
- success: false
- error: |-
- must have required property '_id'
- must have required property 'clientId'
- must have required property 'appId'
- must match exactly one schema in oneOf [invalid-params]
- errorType: invalid-params
- Example 2:
- value:
- success: false
- error: OAuth app not found.
- /api/v1/oauth-apps.delete:
- post:
- tags:
- - OAuth Apps
- summary: Delete OAuth App
- description: 'Permission required: `manage-oauth-apps`'
- operationId: post-api-v1-oauth-apps.delete
- parameters:
- - $ref: '#/components/parameters/X-Auth-Token'
- - $ref: '#/components/parameters/X-User-Id'
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- appId:
- type: string
- description: The OAuth app ID that you want to delete.
- required:
- - appId
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- type: object
- properties:
- success:
- type: boolean
- examples:
- Success:
- value:
- success: true
- '401':
- $ref: '#/components/responses/authorizationError'
- '400':
- description: Bad Request
- content:
- application/json:
- schema:
- type: object
- properties:
- success:
- type: boolean
- error:
- type: string
- errorType:
- type: string
- examples:
- Example 1:
- value:
- success: false
- error: 'must have required property ''appId'' [invalid-params]'
- errorType: invalid-params
- Example 2:
- value:
- success: false
- error: 'Application not found [error-application-not-found]'
- errorType: error-application-not-found
- details:
- method: deleteOAuthApp
tags:
- name: Integration
- - name: OAuth Apps
- - name: WebDAV
components:
parameters:
offset:
diff --git a/messaging.yaml b/messaging.yaml
index 8f34fd4..acff1fe 100644
--- a/messaging.yaml
+++ b/messaging.yaml
@@ -1973,198 +1973,6 @@ paths:
errorType: error-invalid-subscription
details:
method: ignoreUser
- /api/v1/chat.pinMessage:
- post:
- tags:
- - Chat
- summary: Pin Message
- description: |-
- Pin a chat message to the channel.
-
- ### Changelog
- | Version | Description |
- | ------------ | ------------|
- | 0.59.0 | Added |
- operationId: post-api-v1-chat.pinMessage
- parameters:
- - $ref: '#/components/parameters/Auth-Token'
- - $ref: '#/components/parameters/UserId'
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- messageId:
- type: string
- description: The message ID that you want to pin.
- required:
- - messageId
- examples:
- Example:
- value:
- messageId: 7aDSXtjMA3KPLxLjt
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- type: object
- properties:
- message:
- type: object
- properties:
- _id:
- type: string
- t:
- type: string
- rid:
- type: string
- ts:
- type: string
- msg:
- type: string
- u:
- type: object
- properties:
- _id:
- type: string
- username:
- type: string
- name:
- type: string
- groupable:
- type: boolean
- attachments:
- type: array
- items:
- type: object
- properties:
- text:
- type: string
- author_name:
- type: string
- author_icon:
- type: string
- ts:
- type: string
- attachments:
- type: array
- items:
- type: object
- _updatedAt:
- type: string
- success:
- type: boolean
- examples:
- Example 1:
- value:
- message:
- _id: 651f23c0a2f73c7460e18d1a
- t: message_pinned
- rid: 6GFJ3tbmHiyHbahmC
- ts: '2023-10-05T20:59:44.503Z'
- msg: ''
- u:
- _id: 5fRTXMt7DMJbpPJfh
- username: test.test
- name: Testtest
- groupable: false
- attachments:
- - text: hola
- author_name: roxie
- author_icon: /avatar/roxie
- ts: '2023-10-05T20:30:51.052Z'
- attachments: []
- _updatedAt: '2023-10-05T20:59:44.521Z'
- success: true
- '401':
- $ref: '#/components/responses/authorizationError'
- '400':
- description: Bad Request
- content:
- application/json:
- schema:
- type: object
- properties:
- success:
- type: boolean
- error:
- type: string
- errorType:
- type: string
- examples:
- Example 1:
- value:
- success: false
- error: 'The required "messageId" param is missing. [error-messageid-param-not-provided]'
- errorType: error-messageid-param-not-provided
- Example 2:
- value:
- success: false
- error: 'The provided "messageId" does not match any existing message. [error-message-not-found]'
- errorType: error-message-not-found
- /api/v1/chat.unPinMessage:
- post:
- tags:
- - Chat
- summary: Unpin a message
- description: |-
- Remove a pinned message from the channel.
-
- ### Changelog
- | Version | Description |
- | -------------| ------------|
- | 0.59.0 | Added |
- operationId: post-api-v1-chat.unPinMessage
- parameters:
- - $ref: '#/components/parameters/Auth-Token'
- - $ref: '#/components/parameters/UserId'
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- messageId:
- type: string
- description: The message ID you want to to unpin.
- required:
- - messageId
- examples:
- Example:
- value:
- messageId: 7aDSXtjMA3KPLxLjt
- responses:
- '200':
- $ref: '#/components/responses/trueSuccess'
- '401':
- $ref: '#/components/responses/authorizationError'
- '400':
- description: Bad Request
- content:
- application/json:
- schema:
- type: object
- properties:
- success:
- type: boolean
- error:
- type: string
- errorType:
- type: string
- examples:
- Missing Parameter:
- value:
- success: false
- error: 'The required "messageId" param is missing. [error-messageid-param-not-provided]'
- errorType: error-messageid-param-not-provided
- Invalid Parameter:
- value:
- success: false
- error: 'The provided "messageId" does not match any existing message. [error-message-not-found]'
- errorType: error-message-not-found
/api/v1/chat.postMessage:
post:
tags:
@@ -3854,75 +3662,6 @@ paths:
errorType: error-invalid-user
details:
method: createDirectMessage
- /api/v1/dm.delete:
- post:
- tags:
- - DM
- summary: Delete DM
- description: |-
- Delete a DM. Permission required: `view-room-administration`.
-
- ### Changelog
- | Version | Description |
- | ------------ | ------------|
- |3.18.0 | Added |
- operationId: post-api-v1-im.delete
- parameters:
- - $ref: '#/components/parameters/Auth-Token'
- - $ref: '#/components/parameters/UserId'
- requestBody:
- content:
- application/json:
- schema:
- oneOf:
- - type: object
- required: ["roomId"]
- properties:
- roomId:
- type: string
- description: The room ID of the DM. This parameter is required if you don't enter the `username` parameter.
- - type: object
- required: ["username"]
- properties:
- username:
- type: string
- description: The username of the user in the DM.
- examples:
- Example:
- value:
- roomId: hdy9972092873h8s7s0
- responses:
- '200':
- $ref: '#/components/responses/trueSuccess'
- '400':
- description: Bad Request
- content:
- application/json:
- schema:
- type: object
- properties:
- success:
- type: boolean
- error:
- type: string
- errorType:
- type: string
- examples:
- Example 1:
- value:
- success: false
- error: |-
- must have required property 'roomId'
- must have required property 'username'
- must match exactly one schema in oneOf [invalid-params]
- errorType: invalid-params
- Invalid room ID or username:
- value:
- success: false
- error: '[invalid-channel]'
- errorType: invalid-channel
- '401':
- $ref: '#/components/responses/authorizationError'
/api/v1/dm.files:
get:
tags:
diff --git a/settings.yaml b/settings.yaml
index 3d0c6a9..2b9e886 100644
--- a/settings.yaml
+++ b/settings.yaml
@@ -925,67 +925,6 @@ paths:
name: rid
description: The room ID.
required: true
- /api/v1/e2e.setRoomKeyID:
- parameters: []
- post:
- summary: Set Room E2E Key
- operationId: post-api-v1-e2e.setRoomKeyID
- responses:
- '200':
- $ref: '#/components/responses/trueSuccess'
- '400':
- description: Bad Request
- content:
- application/json:
- schema:
- type: object
- properties:
- success:
- type: boolean
- error:
- type: string
- errorType:
- type: string
- examples:
- Invalid Params:
- value:
- success: false
- error: 'must have required property ''rid'' [invalid-params]'
- errorType: invalid-params
- E2E Key Exists:
- value:
- success: false
- error: 'E2E Key ID already exists [error-room-e2e-key-already-exists]'
- errorType: error-room-e2e-key-already-exists
- details:
- method: e2e.setRoomKeyID
- '401':
- $ref: '#/components/responses/authorizationError'
- tags:
- - E2E
- parameters:
- - $ref: '#/components/parameters/X-User-Id'
- - $ref: '#/components/parameters/X-Auth-Token'
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- rid:
- type: string
- description: The room ID.
- keyID:
- type: string
- description: The key that you want to set for the room. Enter a unique string.
- required:
- - rid
- - keyID
- examples:
- Example:
- value:
- rid: wCiXndNp5NqNY3uCc
- keyID: my-UniQu3_ke4_Id
/api/v1/e2e.setUserPublicAndPrivateKeys:
parameters: []
post:
diff --git a/user-management.yaml b/user-management.yaml
index 0784ed7..4b98458 100644
--- a/user-management.yaml
+++ b/user-management.yaml
@@ -11,176 +11,6 @@ info:
servers:
- url: https://apiexplorer.support.rocket.chat
paths:
- /api/v1/permissions.listAll:
- get:
- tags:
- - Permissions
- summary: List All Permissions
- description: |-
- Returns the list of permissions from the workspace.
-
- ### Changelog
- | Version | Description |
- | ---------------- | ------------|
- |0.73.0 | Added |
- operationId: get-permissions.listAll
- parameters:
- - name: updatedSince
- in: query
- description: |-
- Date as ISO string. If you include this parameter, the `update` and
- `remove` fields in the response will contain only those permissions
- updated and removed since this date and time.
- schema:
- type: string
- example: '2017-11-25T15:08:17.248Z'
- - $ref: '#/components/parameters/UserId'
- - $ref: '#/components/parameters/Auth-Token'
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- type: object
- properties:
- update:
- type: array
- items:
- type: object
- properties:
- _id:
- type: string
- _updatedAt:
- type: string
- roles:
- type: array
- items:
- type: string
- remove:
- type: array
- items:
- type: object
- success:
- type: boolean
- examples:
- Success Example:
- value:
- update:
- - _id: access-permissions
- _updatedAt: '2018-11-28T11:55:49.106Z'
- roles:
- - admin
- - _id: add-oauth-service
- _updatedAt: '2018-11-28T12:59:51.974Z'
- roles:
- - admin
- - user
- remove: []
- success: true
- '401':
- $ref: '#/components/responses/authorizationError'
- /api/v1/permissions.update:
- post:
- summary: Update Permissions
- description: |-
- Update the permissions on the workspace.
- Permission required: `access-permissions`
- ### Changelog
- | Version | Description |
- | ---------------- | ------------|
- |0.66.0 | Added |
- operationId: post-api-v1-permissions.update
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- permissions:
- type: array
- description: The array of roles to overwrite.
- items:
- type: object
- properties:
- _id:
- type: string
- example: access-permissions
- roles:
- type: array
- items:
- type: string
- example: admin
- required:
- - permissions
- examples:
- Example 1:
- value:
- permissions:
- - _id: access-permissions
- roles:
- - admin
- description: ''
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- type: object
- properties:
- permissions:
- type: array
- items:
- type: object
- properties:
- _id:
- type: string
- roles:
- type: array
- items:
- type: string
- success:
- type: boolean
- examples:
- Success Example:
- value:
- permissions:
- - _id: access-permissions
- roles:
- - admin
- success: true
- '400':
- description: Bad Request
- content:
- application/json:
- schema:
- type: object
- properties:
- success:
- type: boolean
- error:
- type: string
- errorType:
- type: string
- examples:
- Example 1:
- value:
- success: false
- error: Invalid body params
- errorType: error-invalid-body-params
- Example 2:
- value:
- success: false
- error: Editing permissions is not allowed
- errorType: error-edit-permissions-not-allowed
- '401':
- $ref: '#/components/responses/authorizationError'
- parameters:
- - $ref: '#/components/parameters/UserId'
- - $ref: '#/components/parameters/Auth-Token'
- tags:
- - Permissions
/api/v1/roles.create:
post:
tags: