settings.yaml

openapi: 3.0.0
info:
  version: 1.0.0
  title: Settings
#  description: |-
#    Configure your Rocket.Chat workspace with the following endpoints:
#      * **Settings**: Manage public and private settings.
#      * **Cloud**: Register your workspace on Rocket.Chat Cloud.
#      * **DNS**: Resolve DNS text and URL records.
#      * **E2E**: Create and manage [E2E](https://docs.rocket.chat/use-rocket.chat/workspace-administration/settings/e2e-encryption) keys.
#      * **Import** and **Bulk user import**: Import users, rooms, and other details to your workspace.
#      * **Instances**: View details of your instances.
#      * **Federation**: Add and manage [federated](https://docs.rocket.chat/use-rocket.chat/workspace-administration/settings/federation) servers.
#      * **Moderation**: View and manage [reported messages](https://docs.rocket.chat/use-rocket.chat/workspace-administration/moderation).
#      * **Device management**: Manage [user sessions](https://docs.rocket.chat/use-rocket.chat/user-management/device-manager) on the workspace.
servers:
  - url: https://apiexplorer.support.rocket.chat
paths:
  /api/v1/settings.public:
    get:
      summary: Get Public Settings
      operationId: get-api-v1-settings.public
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  settings:
                    type: array
                    items:
                      type: object
                      properties:
                        _id:
                          type: string
                        value:
                          oneOf:
                            - type: boolean
                            - type: string
                  count:
                    type: integer
                  offset:
                    type: integer
                  total:
                    type: integer
                  success:
                    type: boolean
              examples:
                Success Example:
                  value:
                    settings:
                      - _id: API_Drupal_URL
                        value: ''
                      - _id: API_Embed
                        value: true
                    count: 2
                    offset: 0
                    total: 2
                    success: true
      tags:
        - Settings
      description: |-
        List all public settings. Learn how this can be used in configuring your workspace in this <a href="https://docs.rocket.chat/docs/manage-settings-using-environmental-variables" target="_blank">guide</a>.

        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |7.0.0            | Added the `_id` query parameter for filtering.|
        |7.0.0            | Removed the `query` parameter.      |
      parameters:
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/count'
        - $ref: '#/components/parameters/fields'
        - name: _id
          in: query
          description: 'Filter by the `_id` of the settings.'
          schema:
            type: string
          example: Site_Url, LDAP_Enable
        - schema:
            type: string
          in: query
          name: sort
          description: |-
           Sort the settings in ascending or descending order. By default, settings are sorted by setting ID in ascending order. The sort options are:
            * `createdAt`: Sort by creation date. `sort={"createdAt": 1}` or `sort={"createdAt": -1}`
            * `_id`: Sort by setting ID. `sort={"_id": 1}` or `sort={"_id": -1}`
  /api/v1/settings.oauth:
    get:
      summary: Get OAuth Settings
      operationId: get-api-v1-settings.oauth
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  services:
                    type: array
                    items:
                      type: object
                      properties:
                        _id:
                          type: string
                        name:
                          type: string
                        clientId:
                          type: string
                        buttonLabelText:
                          type: string
                        buttonColor:
                          type: string
                        buttonLabelColor:
                          type: string
                        custom:
                          type: boolean
                        service:
                          type: string
                        serverURL:
                          type: string
                        tokenPath:
                          type: string
                        identityPath:
                          type: string
                        authorizePath:
                          type: string
                        scope:
                          type: string
                        loginStyle:
                          type: string
                        tokenSentVia:
                          type: string
                        identityTokenSentVia:
                          type: string
                        usernameField:
                          type: string
                        mergeUsers:
                          type: boolean
                  success:
                    type: boolean
              examples:
                Success Example:
                  value:
                    services:
                      - _id: iJeY7x4wxnh2p3pLr
                        name: facebook
                        clientId: test
                        buttonLabelText: test
                        buttonColor: '#13679A'
                        buttonLabelColor: '#FFFFFF'
                        custom: false
                      - _id: iJeY7x4wxnh2p3pLr
                        name: twitter
                        clientId: test
                        buttonLabelText: ''
                        buttonColor: ''
                        buttonLabelColor: ''
                        custom: false
                      - _id: 5RQ4SBL3NuZKsqxaF
                        service: test
                        clientId: test
                        custom: true
                        serverURL: /test/test
                        tokenPath: /oauth/token
                        identityPath: /me
                        authorizePath: /oauth/authorize
                        scope: openid
                        buttonLabelText: test
                        buttonLabelColor: '#FFFFFF'
                        loginStyle: popup
                        buttonColor: '#13679A'
                        tokenSentVia: payload
                        identityTokenSentVia: default
                        usernameField: dfsgdfgdfgdfgsd
                        mergeUsers: true
                    success: true
      tags:
        - Settings
      description: |-
        List all the <a href="https://docs.rocket.chat/docs/oauth" target="_blank"> OAuth services</a>. enabled in the workspace.
        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |0.64.0            | Renamed field `appId` to `clientId` and added flag `custom` to indicate whether the OAuth service is customized and fix `id` inconsistence (set all cases to `_id`)       |
        |0.63.0            | Added       |
      parameters: []
  /api/v1/settings:
    parameters: []
    get:
      summary: Get Private Settings
      operationId: get-api-v1-settings
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  settings:
                    type: array
                    items:
                      type: object
                      properties:
                        _id:
                          type: string
                        value:
                          oneOf:
                            - type: boolean
                            - type: string
                  count:
                    type: integer
                  offset:
                    type: integer
                  total:
                    type: integer
                  success:
                    type: boolean
              examples:
                Success Example:
                  value:
                    settings:
                      - _id: API_Allow_Infinite_Count
                        value: true
                      - _id: API_CORS_Origin
                        value: '*'
                    count: 50
                    offset: 0
                    total: 299
                    success: true
                success example with query parameter:
                  value:
                    settings:
                      - _id: API_Allow_Infinite_Count
                        value: true
                        packageValue: true
                        enterprise: false
                      - _id: API_Apply_permission_view-outside-room_on_users-list
                        value: false
                        packageValue: false
                        enterprise: false
                      - _id: API_CORS_Origin
                        value: '*'
                        packageValue: '*'
                        enterprise: false
                    count: 3
                    offset: 0
                    total: 10
                    success: true
        '401':
          $ref: '#/components/responses/authorizationError'
      tags:
        - Settings
      description: 'List all private settings. Learn how this can be used in configuring your server in this <a href="https://docs.rocket.chat/docs/deployment-environment-variables" target="_blank">guide</a>.'
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
        - schema:
            type: boolean
          in: query
          name: includeDefaults
          description: 'When set to true, it fetches both the current value and the default value (packageValue) of the settings'
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/count'
    post:
      summary: Update Settings in Bulk
      operationId: post-api-v1-settings
      description: |-
        Updates multiple private workspace settings in a single request. 

        Permission required: `edit-privileged-setting`

        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |8.6.0            | Added       |
      tags:
        - Settings
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
        - $ref: '#/components/parameters/x-2fa-code'
        - $ref: '#/components/parameters/X-2fa-method'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                settings:
                  type: array
                  description: The list of settings to update.
                  minItems: 1
                  items:
                    type: object
                    properties:
                      _id:
                        type: string
                        description: The unique ID of the setting.
                      value:
                        description: The value to set for the setting. The accepted type depends on the setting.
                    required:
                      - _id
                      - value
              required:
                - settings
            examples:
              Example:
                value:
                  settings:
                    - _id: API_Allow_Infinite_Count
                      value: false
                    - _id: API_CORS_Origin
                      value: 'https://example.com'
      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 ''settings'' [invalid-params]'
                    errorType: invalid-params
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  error:
                    type: string
                  errorType:
                    type: string
                  details:
                    type: object
                    properties:
                      method:
                        type: string
                      settingIds:
                        type: array
                        items:
                          type: string
              examples:
                Permission Error:
                  value:
                    success: false
                    error: 'Editing settings is not allowed [error-action-not-allowed]'
                    errorType: error-action-not-allowed
                    details:
                      method: saveSettings
                      settingIds:
                        - API_Allow_Infinite_Count
                        - API_CORS_Origin 
  /api/v1/settings.addCustomOAuth:
    parameters: []
    post:
      description: Add a <a href=" https://docs.rocket.chat/docs/oauth#add-custom-oauth" target="_blank">custom OAuth integration</a> to your workspace.
      summary: Add Custom OAuth
      operationId: post-api-v1-settings.addCustomOAuth
      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:
                Missing name param:
                  value:
                    success: false
                    error: 'The parameter "name" is required [error-name-param-not-provided]'
                    errorType: error-name-param-not-provided
        '401':
          $ref: '#/components/responses/authorizationError'
      tags:
        - Settings
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
        - $ref: '#/components/parameters/x-2fa-code'
        - $ref: '#/components/parameters/X-2fa-method'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The name of the custom OAuth method that you want to add.
              required:
                - name
  '/api/v1/settings/{_id}':
    parameters:
      - schema:
          type: string
        name: _id
        in: path
        required: true
        description: The unique ID of the setting that you want to update or fetch.
    post:
      summary: Update Setting
      tags:
        - Settings
      responses:
        '200':
          $ref: '#/components/responses/trueSuccess'
        '401':
          $ref: '#/components/responses/authorizationError'
      operationId: post-api-v1-settings-_id
      description: |-
        Permission required: `edit-privileged-setting`

        The `_id` of a setting is the first argument of the `RocketChat.settings.add` method used in `Rocket.Chat/packages/rocketchat-lib/server/startup/settings.js` (among other files).

        For example, the following code in `settings.js` file:
          ```json
          this.add('Accounts_AllowAnonymousRead', false, {
            type: 'boolean',
            public: true  });
          ```
          This means that the setting labeled `Allow anonymous read` in the section `Accounts` has `_id` equal to `Accounts_AllowAnonymousRead`. The second argument is the default value (false). The third argument specifies the variable's type and whether it is public, hidden, and so on.

          To set a color, you can send:
          ```json
          { value: '<color-code>',
            editor: 'color' }
          ```

          And also to trigger a action-button, use:
          ```json
          { execute: true }
          ```
          ### Changelog
          | Version      | Description |
          | ---------------- | ------------|
          |0.65.0            | Added option to set a color and trigger an action       |
          |0.42.0            | Added       |
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
        - $ref: '#/components/parameters/x-2fa-code'
        - $ref: '#/components/parameters/X-2fa-method'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                value:
                  type: string
                  description: The value to update the setting.
                color:
                  type: string
                  description: The color code to update the setting.
                editor:
                  type: string
                  description: 'The editor key, with color value. Required, if color was set.'
                execute:
                  type: boolean
                  description: To trigger a action-button.
              required:
                - value
    get:
      summary: Get Setting
      tags:
        - Settings
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  _id:
                    type: string
                  value:
                    type: boolean
                  success:
                    type: boolean
              examples:
                Success Example:
                  value:
                    _id: Livechat_enabled
                    value: false
                    success: true
        '401':
          $ref: '#/components/responses/authorizationError'
      operationId: get-api-v1-settings-_id
      description: |-
        Get details of a setting by ID.
        Permission required: `view-privileged-setting`
        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |0.42.0            | Added       |
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
  /api/v1/service.configurations:
    parameters: []
    get:
      summary: Get OAuth Service Configuration
      operationId: get-api-v1-service.configurations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  configurations:
                    type: array
                    items:
                      type: object
                      properties:
                        _id:
                          type: string
                        service:
                          type: string
                        clientId:
                          type: string
                  success:
                    type: boolean
              examples:
                Success Example:
                  value:
                    configurations:
                      - _id: Hq5ahzz9MWWCdeDJ8
                        service: google
                        clientId: xxxxx
                      - _id: 57kavS22achLH33PE
                        service: apple
                        clientId: xxxxxx
                    success: true
      description: List out all the active OAuth services configured with details.
      tags:
        - Settings
  /api/v1/cloud.connectWorkspace:
    post:
      summary: Connect Workspace to Cloud
      operationId: post-api-v1-cloud.connectWorkspace
      description: |-
        Connect the workspace to <a href="https://docs.rocket.chat/docs/rocketchat-cloud" target="_blank">Rocket.Chat Cloud</a> using a registration token. To get a registration token, refer to [Registration via Token](https://docs.rocket.chat/docs/register-your-workspace#how-to-get-a-token).

        Permission required: `manage-cloud`.

        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |8.7.0            | Added       |
      tags:
        - Cloud
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                token:
                  type: string
                  description: The registration token from your Rocket.Chat Cloud account.
                  example: 5f03461b-9073-41e5-986d-e70f4d6ecbd1
              required:
                - token
            examples:
              Example:
                value:
                  token: 5f03461b-9073-41e5-986d-e70f4d6ecbd1
      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 Parameter:
                  value:
                    success: false
                    error: 'must have required property ''token'' [invalid-params]'
                    errorType: invalid-params
                Failed to Connect:
                  value:
                    success: false
                    error: Failed to connect the workspace with Rocket.Chat Cloud
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          $ref: '#/components/responses/forbiddenError'
  /api/v1/cloud.manualRegister:
    post:
      summary: Manual Cloud Register
      operationId: post-api-v1-cloud.manualRegister
      responses:
        '200':
          $ref: '#/components/responses/trueSuccess'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  error:
                    type: string
              examples:
                Example:
                  value:
                    success: false
                    error: Workspace is already registered
                Example 2:
                  value:
                    success: false
                    error: 'Match error: Missing key ''cloudBlob'''
        '401':
          $ref: '#/components/responses/authorizationError'
      description: |-
        Manually register a workspace on <a href="https://docs.rocket.chat/docs/rocketchat-cloud" target="_blank">Rocket.Chat Cloud</a>.
        Permission required: `register-on-cloud`.
      tags:
        - Cloud
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                cloudBlob:
                  type: string
                  description: Enter the workspace deployment ID.
              required:
                - cloudBlob
            examples:
              Example:
                value:
                  cloudBlob: jfiscsm38urc3ujd
  /api/v1/cloud.registrationStatus:
    get:
      summary: Get Workspace Registration Status
      operationId: get-api-v1-cloud.registrationStatus
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  registrationStatus:
                    type: object
                    properties:
                      workspaceRegistered:
                        type: boolean
                        description: 'Whether the workspace has an active Cloud Client ID and Secret configured.'
                      workspaceId:
                        type: string
                        description: 'The workspace''s Rocket.Chat Cloud ID.'
                      uniqueId:
                        type: string
                        description: 'The workspace''s unique installation ID.'
                      token:
                        type: string
                      email:
                        type: string
                        description: 'The registered organization email on Rocket.Chat Cloud.'
                  success:
                    type: boolean
              examples:
                Example:
                  value:
                    registrationStatus:
                      workspaceRegistered: true
                      workspaceId: abc123-workspace-id
                      uniqueId: xyz789-unique-id
                      token: ''
                      email: admin@example.com
                    success: true
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          $ref: '#/components/responses/forbiddenError'
      description: |-
        Returns the workspace's current Rocket.Chat Cloud registration status. 
        
        Permission required: `manage-cloud`.
      tags:
        - Cloud
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
  /api/v1/dns.resolve.txt:
    parameters: []
    post:
      summary: Resolve DNS Text Records
      operationId: post-api-v1-dns.resolve.txt
      responses:
        '200':
          $ref: '#/components/responses/trueSuccess'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  error:
                    type: string
              examples:
                Query Not Found:
                  value:
                    success: false
                    error: querySrv ENOTFOUND .rocket.chat/
        '401':
          $ref: '#/components/responses/authorizationError'
      description: Resolves DNS text records (TXT records) for a hostname.
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
        - schema:
            type: string
          in: query
          name: url
          description: The hostname.
          required: true
      tags:
        - DNS
  /api/v1/dns.resolve.srv:
    parameters: []
    post:
      summary: Resolve DNS URL Records
      operationId: post-api-v1-dns.resolve.srv
      responses:
        '200':
          $ref: '#/components/responses/trueSuccess'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  error:
                    type: string
              examples:
                Query Not Found:
                  value:
                    success: false
                    error: querySrv ENOTFOUND .rocket.chat/
        '401':
          $ref: '#/components/responses/authorizationError'
      description: Resolves DNS URL records for a hostname.
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
        - schema:
            type: string
          in: query
          name: url
          description: The hostname.
          required: true
      tags:
        - DNS
  /api/v1/e2e.fetchMyKeys:
    parameters: []
    get:
      summary: Get E2E Keys
      operationId: get-api-v1-e2e.fetchMyKeys
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  public_key:
                    type: string
                  private_key:
                    type: string
                  success:
                    type: boolean
              examples:
                Success Example:
                  value:
                    public_key: '{"alg":"RSA-OAEP-256","e":"AQAB","ext":true,"key_ops":["encrypt"],"kty":"RSA","n":"oP23XEagSGIdo18Yc7TUwsM1qoRDa-pMg64lEctMQ6Dx-Q"}'
                    private_key: '{"$binary":"2j5AaYO39PcQNK7lT3h5Zv7j7y3rVKsqlERVgty+Z2pjzuG5pCMnx63WFJCrt8Sx2KDwWvYycGs0V5TzXJhKFEpE3l5hpoP51wO1Xztnfl9TdVtCZ5ERSDhXp+t3ays0QLdD2EtZu9M+Ffgiy2gqTasB0UFXAZyDA=="}'
                    success: true
        '401':
          $ref: '#/components/responses/authorizationError'
      description: Retrieves E2E keys of logged in user.
      tags:
        - E2E
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
  /api/v1/e2e.getUsersOfRoomWithoutKey:
    parameters: []
    get:
      summary: Get Users of Room Without E2E key
      operationId: get-api-v1-e2e.getUsersOfRoomWithoutKey
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  users:
                    type: array
                    items:
                      type: object
                      properties:
                        _id:
                          type: string
                        e2e:
                          type: object
                          properties:
                            public_key:
                              type: string
                  success:
                    type: boolean
              examples:
                Success Example:
                  value:
                    users:
                      - _id: XycfA5CetCPuEjqxw
                        e2e:
                          public_key: '{"alg":"RSA-OAEP-256","e":"AQAB","ext":true,"key_ops":["encrypt"],"kty":"RSA","n":"oMO9ydjRxD3JzcAgMvyBZAc_pIOBIxOLVUChZ8mB3JNtLREC751hHT-WPZVZquWA6X4CihHejFfpIyAD_w-0MIToudTGO-f1aeE4Wc9-SBKjSQPphCuZMTwZ7iRtfUwHeGy5yM94uQPp07sEi9BmJSZqHscHc-6G520MyBhNU6uznQf-Sp85Q4etl4Ifs09khM-VMnBqKwh2QJx8w0880Vc3Zufve6udg0aSQ"}'
                    success: true
        '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
                Invalid Room:
                  value:
                    success: false
                    error: 'Invalid room [error-invalid-room]'
                    errorType: error-invalid-room
                    details:
                      method: e2e.getUsersOfRoomWithoutKey
        '401':
          $ref: '#/components/responses/authorizationError'
      description: Retrieves user IDs Of room without E2E key.
      tags:
        - E2E
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
        - schema:
            type: string
          in: query
          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:
      summary: Set User Key
      operationId: post-api-v1-e2e.setUserPublicAndPrivateKeys
      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 ''public_key'' [invalid-params]'
                    errorType: invalid-params
        '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:
                public_key:
                  type: string
                  description: Enter a unique string as your public key.
                private_key:
                  type: string
                  description: Enter a unique string as your private key.
              required:
                - public_key
                - private_key
            examples:
              Example:
                value:
                  public_key: My-9UbLiK-k34
                  private_key: 9R1V4t3_k3Y
  /api/v1/e2e.updateGroupKey:
    post:
      summary: Update User E2E Key in Room
      operationId: post-api-v1-e2e.updateGroupKey
      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
        '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:
                uid:
                  type: string
                  description: The user ID whose key you want to update.
                rid:
                  type: string
                  description: The room ID.
                key:
                  type: string
                  description: The updated key.
              required:
                - uid
                - rid
                - key
            examples:
              Example:
                value:
                  uid: d26x6zSkaPSe5gCyy
                  rid: 9R1V4t3_k3Y
                  key: M4-Ubd4T3d-k39
  /api/v1/e2e.requestSubscriptionKeys:
    post:
      summary: Request Subscription Keys
      operationId: post-api-v1-e2e.requestSubscriptionKeys
      description: |-
        Requests the E2E encryption keys for the rooms the authenticated user is subscribed to. Other room members are notified to share their keys with the requesting user. This endpoint replaces the deprecated `e2e.requestSubscriptionKeys` DDP method. 

        ### Changelog
        | Version | Description |
        | ------- | ------------|
        | 8.6.0   | Added       |
      tags:
        - E2E
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      responses:
        '200':
          $ref: '#/components/responses/trueSuccess'
        '401':
          $ref: '#/components/responses/authorizationError'
  /api/v1/uploadImportFile:
    parameters: []
    post:
      summary: Upload Import File
      operationId: post-api-v1-uploadImportFile
      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
                  details:
                    type: string
              examples:
                Importer not Defined:
                  value:
                    success: false
                    error: 'The importer (png) has no import class defined. [error-importer-not-defined]'
                    errorType: error-importer-not-defined
                    details: uploadImportFile
        '401':
          $ref: '#/components/responses/authorizationError'
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                binaryContent:
                  type: string
                  description: The uploaded file.
                importerKey:
                  type: string
                  description: |-
                    It indicates how Rocket.Chat should handle the uploaded file. The accepted importer keys are:
                      * `csv`
                      * `hipchatenterprise`
                      * `pending-avatars`
                      * `pending-files`
                      * `slack`
                      * `slack-users`
                fileName:
                  type: string
                  description: The name of the file to be imported.
                contentType:
                  type: string
                  description: 'The imported file [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types).'
              required:
                - binaryContent
                - importerKey
                - fileName
                - contentType
            examples:
              Example:
                value:
                  binaryContent: /testfile.csv
                  importerKey: csv
                  fileName: Testfile
                  contentType: text/csv
      tags:
        - Import
      description: |-
        This endpoint takes in the binary content of the imported file, along with additional information about its content, and stores it in a buffer. Permission required: `run-import`.

        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |3.0.0            | Added       |
  /api/v1/downloadPublicImportFile:
    parameters: []
    post:
      summary: Download Public Import File
      operationId: post-api-v1-downloadPublicImportFile
      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
                  details:
                    type: string
              examples:
                Importer not Defined :
                  value:
                    success: false
                    error: 'The importer (png) has no import class defined. [error-importer-not-defined]'
                    errorType: error-importer-not-defined
                    details: uploadImportFile
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          $ref: '#/components/responses/forbiddenError'
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                fileUrl:
                  type: string
                  description: The url of the file. It must start with `http` or `https`.
                importerKey:
                  type: string
                  description: |-
                    It indicates how Rocket.Chat should handle the uploaded file. The accepted importer keys are:
                      * `csv`
                      * `hipchatenterprise`
                      * `pending-avatars`
                      * `pending-files`
                      * `slack`
                      * `slack-users`
              required:
                - fileUrl
                - importerKey
            examples:
              Example:
                value:
                  fileUrl: 'https://www.freepik.com/photos/dog'
                  importerKey: pending-avatars
      tags:
        - Import
      description: |-
        Download the public import file.
        Permission required: `run-import`

        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |3.0.0            | Added       |
  /api/v1/startImport:
    parameters: []
    post:
      summary: Start Import
      operationId: post-api-v1-startImport
      responses:
        '200':
          $ref: '#/components/responses/trueSuccess'
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          $ref: '#/components/responses/forbiddenError'
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - input
              properties:
                input:
                  type: object
                  required:
                    - users
                    - channels
                  description: 'The input object contains two arrays: `users` and `channels`.'
                  properties:
                    users:
                      type: object
                      description: 'An object of the users to be imported. If `all` is true, `list` is ignored.'
                      properties:
                        all:
                          type: boolean
                          description: Set to `true` to import all users.
                        list:
                          type: array
                          description: 'When `all` is false, list the record IDs of users to be imported.'
                          items:
                            type: string
                    channels:
                      type: object
                      description: 'An object of the channels to import. If `all` is true, `list` is ignored.'
                      properties:
                        all:
                          type: boolean
                          description: Set to `true` to import all channels.
                        list:
                          type: array
                          description: 'When `all` is false, list the record IDs of channels to be imported.'
                          items:
                            type: string
            examples:
              Example:
                value:
                  input:
                    users:
                      all: true
                      list:
                        - testbh
                    channels:
                      all: false
                      list:
                        - WDuJLFkjwk6L7LdFC
      tags:
        - Import
      description: |-
        Triggers the process of importing users, rooms and messages to the workspace.
        Permission required: `run-import`

        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |7.0.0            | Remove required extra data from `users` and `channels` parameters. Use only record ID of the users or channels.   |
        |3.0.0            | Added       |
  /api/v1/getImportFileData:
    parameters: []
    get:
      summary: Get Import File Data
      tags:
        - Import
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  users:
                    type: array
                    items:
                      type: object
                      properties: {}
                  channels:
                    type: array
                    items:
                      type: object
                      properties: {}
                  message_count:
                    type: integer
                  success:
                    type: boolean
              examples:
                Example:
                  value:
                    users: []
                    channels: []
                    message_count: 0
                    success: true
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          $ref: '#/components/responses/forbiddenError'
      operationId: get-api-v1-getImportFileData
      description: |-
        Get the import file data.
        Permission required: `run-import`
        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |3.0.0            | Added       |
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
  /api/v1/getImportProgress:
    parameters: []
    get:
      summary: Get Import Progress
      tags:
        - Import
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  key:
                    type: string
                  name:
                    type: string
                  step:
                    type: string
                  count:
                    type: object
                    properties:
                      completed:
                        type: integer
                      total:
                        type: integer
                  success:
                    type: boolean
              examples:
                Success:
                  value:
                    key: pending-avatars
                    name: Pending Avatars
                    step: importer_user_selection
                    count:
                      completed: 0
                      total: 0
                    success: true
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          $ref: '#/components/responses/forbiddenError'
      operationId: get-api-v1-getImportProgress
      description: |-
        Get the progress of the import.
        Permission required: `run-import`
        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |3.0.0            | Added       |
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
  /api/v1/getLatestImportOperations:
    parameters: []
    get:
      summary: Get Latest Import Operations
      tags:
        - Import
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    _id:
                      type: string
                    type:
                      type: string
                    importerKey:
                      type: string
                    ts:
                      type: integer
                    status:
                      type: string
                    valid:
                      type: boolean
                    user:
                      type: string
                    _updatedAt:
                      type: string
              examples:
                Success:
                  value:
                    - _id: MJxTRZsYdho8Ww2qq
                      type: Pending Avatars
                      importerKey: pending-avatars
                      ts: 1635280600083
                      status: importer_user_selection
                      valid: false
                      user: d26x6zSkaPSe5gCyy
                      _updatedAt: '2021-10-27T11:26:24.430Z'
                    - _id: YzSCu9WgqJ3wutF4T
                      type: Pending Files
                      importerKey: pending-files
                      ts: 1635280596592
                      status: importer_done
                      valid: false
                      user: d26x6zSkaPSe5gCyy
                      _updatedAt: '2021-10-27T08:32:42.609Z'
                    - _id: 96WJDaxXpwXC3fTD5
                      type: Pending Files
                      importerKey: pending-files
                      ts: 1635277590992
                      status: importer_user_selection
                      valid: false
                      user: d26x6zSkaPSe5gCyy
                      _updatedAt: '2021-10-27T08:32:42.609Z'
                    - _id: zYc5kuFRaszfqCegB
                      type: Pending Avatars
                      importerKey: pending-avatars
                      ts: 1635277492185
                      status: importer_done
                      valid: false
                      user: d26x6zSkaPSe5gCyy
                      _updatedAt: '2021-10-27T08:32:42.609Z'
                    - _id: XckCNn9ZsdywHso4f
                      type: Pending Avatars
                      importerKey: pending-avatars
                      ts: 1635277452755
                      status: importer_done
                      valid: false
                      user: d26x6zSkaPSe5gCyy
                      _updatedAt: '2021-10-27T08:32:42.609Z'
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          $ref: '#/components/responses/forbiddenError'
      operationId: get-api-v1-getLatestImportOperations
      description: |-
        Get latests import operations.
        Permission required: `view-import-operations`
        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |3.0.0            | Added       |
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
  /api/v1/downloadPendingFiles:
    parameters: []
    post:
      summary: Download Pending Files
      operationId: post-api-v1-downloadPendingFiles
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  count:
                    type: integer
              examples:
                Success:
                  value:
                    success: true
                    count: 0
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          $ref: '#/components/responses/forbiddenError'
      description: |-
        Dowbload pending files.
        Permission required: `run-import`
        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |3.0.0            | Added       |
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      tags:
        - Import
  /api/v1/downloadPendingAvatars:
    parameters: []
    post:
      summary: Download Pending Avatars
      operationId: post-api-v1-downloadPendingAvatars
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  count:
                    type: integer
              examples:
                Success:
                  value:
                    success: true
                    count: 0
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          $ref: '#/components/responses/forbiddenError'
      description: |-
        Download pending avatars from the import.
        Permission required: `run-import`
        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |3.0.0            | Added       |
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      tags:
        - Import
  /api/v1/getCurrentImportOperation:
    parameters: []
    get:
      summary: Get Current Import Operations
      operationId: get-api-v1-getCurrentImportOperation
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  operation:
                    type: object
                    properties:
                      _id:
                        type: string
                      type:
                        type: string
                      importerKey:
                        type: string
                      ts:
                        type: integer
                      status:
                        type: string
                      valid:
                        type: boolean
                      user:
                        type: string
                      _updatedAt:
                        type: string
              examples:
                Success:
                  value:
                    success: true
                    operation:
                      _id: 7PbvsnKJD9ZAqw38C
                      type: Pending Avatars
                      importerKey: pending-avatars
                      ts: 1635337234169
                      status: importer_done
                      valid: true
                      user: d26x6zSkaPSe5gCyy
                      _updatedAt: '2021-10-27T12:20:34.184Z'
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          $ref: '#/components/responses/forbiddenError'
      description: |-
        Get the current import operation.
        Permission required: `run-import`
        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |3.0.0            | Added       |
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      tags:
        - Import
  /api/v1/importers.list:
    get:
      summary: Get List of Imports
      tags:
        - Import
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    key:
                      type: string
                    name:
                      type: string
              examples:
                Example 1:
                  value:
                    - key: csv
                      name: CSV
                    - key: slack
                      name: Slack
                    - key: slack-users
                      name: Slack_Users
                    - key: omnichannel_contact
                      name: omnichannel_contacts_importer
        '401':
          $ref: '#/components/responses/authorizationError'
      operationId: get-api-v1-importers.list
      description: 'Use this endpoint to view the list of imports in the workspace. Permission required: `run-import`'
      parameters:
        - $ref: '#/components/parameters/X-Auth-Token'
        - $ref: '#/components/parameters/X-User-Id'        
  /api/v1/import.new:
    post:
      summary: Create New Import Operation
      operationId: post-api-v1-import.new
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  operation:
                    type: object
                    properties:
                      _id:
                        type: string
                      type:
                        type: string
                      importerKey:
                        type: string
                      ts:
                        type: string
                      status:
                        type: string
                      valid:
                        type: boolean
                      user:
                        type: string
                      _updatedAt:
                        type: string
                  success:
                    type: boolean
              examples:
                Success:
                  value:
                    operation:
                      _id: 64d69545ee8ae821983005f5
                      type: api
                      importerKey: api
                      ts: '2023-08-11T20:08:37.655Z'
                      status: importer_new
                      valid: true
                      user: rbAXPnMktTFbNpwtJ
                      _updatedAt: '2023-08-11T20:08:37.655Z'
                    success: true
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          $ref: '#/components/responses/forbiddenError'
      description: |-
        Creates a new import operation; if an operation was already running, it will be aborted. Any data from previous imports will be cleared automatically.
        Permission required: `run-import`
        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |6.3.0            | Added       |
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      tags:
        - Bulk User Import
  /api/v1/import.addUsers:
    parameters: []
    post:
      summary: Add Users
      operationId: post-api-v1-import.addUsers
      responses:
        '200':
          $ref: '#/components/responses/trueSuccess'
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          $ref: '#/components/responses/forbiddenError'
      description: |-
        Adds user data to the import staging area. It requires the current import operation status to be either `new` or `ready`. If successful, it changes the operation state to `ready`.
        Permission required: `run-import`
        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |6.3.0            | Added       |
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      tags:
        - Bulk User Import
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: object
                    properties:
                      username:
                        type: string
                        description: The user name.
                      emails:
                        type: array
                        description: The user email addresses.
                        items:
                          type: string
                      importIds:
                        type: array
                        description: A list of IDs that can identify the user.
                        items:
                          type: string
                      name:
                        type: string
                        description: The user's display name.
                      password:
                        type: string
                        description: A password to assign to this user.
                      utcOffset:
                        type: number
                        description: 'The user''s timezone, in number of hours relative to UTC.'
                      roles:
                        type: array
                        description: A list of roles to assign to the user
                        items:
                          type: string
                      type:
                        type: string
                        description: 'The user type, must be either "user" or "bot".'
                      bio:
                        type: string
                        description: The user's profile bio.
                      deleted:
                        type: boolean
                        description: Was the user deleted from the previous system?
                      avatarUrl:
                        type: string
                        description: A URL pointing to the user's avatar picture.
                    required:
                      - emails
                      - importIds
            examples:
              Example:
                value:
                  users:
                    - username: john.doe
                      emails:
                        - john.doe@example.com
                      importIds:
                        - '1523'
                      name: John Doe
                      password: P@ssw0rd
                    - username: jane.doe
                      emails:
                        - jane.doe@example.com
                      importIds:
                        - '1524'
                      name: Jane Doe
        description: |-
          Note:
            1. A minimum of one email address and one import ID is required. If any user is missing those, the endpoint will fail and no user will be added to the operation.
            2. Emails and usernames will not be validated, but they must be unique or the user creation will fail.
            3. If roles are added, they must be valid Rocket.Chat roles, or the endpoint will fail and no user will be added to the operation.
            4. The default roles will be added to all users automatically.
            5. If no password is added, a temporary random password will be generated automatically.
            6. Users flagged as `deleted` will be created as `Deactivated` on Rocket.Chat.
            7. Avatar URLs will not be fetched automatically. The workspace administrator needs to use the **Download Pending Avatars** button in **Manage** > **Workspace** > **Import** on the workspace after the import is completed.
            8. Import IDs will not be used as IDs by Rocket.Chat, but you can query users by their import ID with the  <a href="https://developer.rocket.chat/apidocs/get-users-info" target="_blank">users.info</a>.
  /api/v1/import.run:
    parameters: []
    post:
      summary: Run Import Operation
      operationId: post-api-v1-import.run
      responses:
        '200':
          $ref: '#/components/responses/trueSuccess'
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          $ref: '#/components/responses/forbiddenError'
      description: |-
        Process the data from the current import operation, creating the users on Rocket.Chat. It requires the current import operation state to be `ready` and it changes the operation state to `importing`. It will return success if the conditions to start the process are met, without waiting for the import to finish.
        Permission required: `run-import`

        1. If a user can not be imported successfully it'll be flagged but the operation will not stop.
        2. If a user's email or username is already in use, it will not be created.
        3. Only the users that were imported successfully will be removed from the staging area.

        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |6.3.0            | Added       |
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      tags:
        - Bulk User Import
  /api/v1/import.status:
    parameters: []
    get:
      summary: Get Import Operation Status
      operationId: get-api-v1-import.status
      responses:
        '200':
          description: |-
            The following operation statuses are possible for the operation:
              * `none`: No import operation was ever created.
              * `new`: An operation was created but no data was added to it.
              * `loading`: A traditional importer is currently loading data from a file to the import operation.
              * `ready`: An operation was created and has data ready to import.
              * `importing`: The import operation is running and the users are being created.
              * `error`: An error caused the operation to stop running.
              * `canceled`: The operation was interrupted by an administrator.
              * `done`: The operation was completed successfully.

              Note the following points:
                1. The operation is considered successful if it processes every user in the staging area, even if no user is imported.
                2. You can check how many users have been imported or failed to import with the `operation.count.completed` and `operation.count.error` attributes.
                3. The data from users that failed to import will remain in the staging area after the operation is complete.
                4. While the operation is running, the values on `operation.count` are only updated once after every 50 users are processed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  state:
                    type: string
                  operation:
                    type: object
                    properties:
                      _id:
                        type: string
                      type:
                        type: string
                      importerKey:
                        type: string
                      ts:
                        type: string
                      status:
                        type: string
                      valid:
                        type: boolean
                      user:
                        type: string
                      _updatedAt:
                        type: string
                      count:
                        type: object
                        properties:
                          total:
                            type: integer
                          users:
                            type: integer
                  success:
                    type: boolean
              examples:
                Success Example:
                  value:
                    state: ready
                    operation:
                      _id: 64d51ea91558939980aab371
                      type: api
                      importerKey: api
                      ts: '2023-08-10T17:30:17.519Z'
                      status: importer_user_selection
                      valid: true
                      user: 7TY57bBj3xQXvf2i2
                      _updatedAt: '2023-08-10T17:41:20.052Z'
                      count:
                        total: 2
                        users: 2
                    success: true
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          $ref: '#/components/responses/forbiddenError'
      description: |-
        Get the status of the current import operation.Permission required: `run-import`
        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |6.3.0            | Added       |
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      tags:
        - Bulk User Import
  /api/v1/import.clear:
    parameters: []
    post:
      summary: Abort Import Operation
      operationId: post-api-v1-import.clear
      responses:
        '200':
          $ref: '#/components/responses/trueSuccess'
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          $ref: '#/components/responses/forbiddenError'
      tags:
        - Bulk User Import
      description: |-
        Abort any import operation currently in progress. Clear any remaining data that may have been left by any previous operation.
        Permission required: `run-import`
        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |6.3.0            | Added       |
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
  /api/v1/instances.get:
    parameters: []
    get:
      summary: Get Instances
      operationId: get-api-v1-instances.get
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  instances:
                    type: array
                    items:
                      type: object
                      properties:
                        address:
                          type: string
                        currentStatus:
                          type: object
                          properties:
                            connected:
                              type: boolean
                            lastHeartbeatTime:
                              type: integer
                            local:
                              type: boolean
                        instanceRecord:
                          type: object
                          properties:
                            _id:
                              type: string
                            _createdAt:
                              type: string
                            _updatedAt:
                              type: string
                            extraInformation:
                              type: object
                              properties:
                                host:
                                  type: string
                                port:
                                  type: string
                                tcpPort:
                                  type: integer
                                os:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                    platform:
                                      type: string
                                    arch:
                                      type: string
                                    release:
                                      type: string
                                    uptime:
                                      type: number
                                    loadavg:
                                      type: array
                                      items:
                                        type: number
                                    totalmem:
                                      type: integer
                                    freemem:
                                      type: integer
                                    cpus:
                                      type: integer
                                nodeVersion:
                                  type: string
                                conns:
                                  type: integer
                            name:
                              type: string
                            pid:
                              type: integer
                        broadcastAuth:
                          type: boolean
                  success:
                    type: boolean
                x-examples:
                  Example:
                    instances:
                      - address: localhost
                        currentStatus:
                          connected: true
                          lastHeartbeatTime: 16
                          local: true
                        instanceRecord:
                          _id: 871f8be4-5fdb-45a8-868f-8d3e28a39148
                          _createdAt: '2024-05-22T11:14:11.845Z'
                          _updatedAt: '2024-07-05T02:55:40.526Z'
                          extraInformation:
                            host: localhost
                            port: '3000'
                            tcpPort: 46443
                            os:
                              type: Linux
                              platform: linux
                              arch: x64
                              release: 5.10.165-143.735.amzn2.x86_64
                              uptime: 8455403.28
                              loadavg:
                                - 0.41
                                - 0.17
                                - 0.15
                              totalmem: 4110323712
                              freemem: 198479872
                              cpus: 2
                            nodeVersion: v14.21.3
                            conns: 1
                          name: rocket.chat
                          pid: 1
                        broadcastAuth: true
                    success: true
              examples:
                Get Instances:
                  value:
                    instances:
                      - address: localhost
                        currentStatus:
                          connected: true
                          lastHeartbeatTime: 16
                          local: true
                        instanceRecord:
                          _id: 871f8be4-5fdb-45a8-868f-8d3e28a39148
                          _createdAt: '2024-05-22T11:14:11.845Z'
                          _updatedAt: '2024-07-05T02:55:40.526Z'
                          extraInformation:
                            host: localhost
                            port: '3000'
                            tcpPort: 46443
                            os:
                              type: Linux
                              platform: linux
                              arch: x64
                              release: 5.10.165-143.735.amzn2.x86_64
                              uptime: 8455403.28
                              loadavg:
                                - 0.41
                                - 0.17
                                - 0.15
                              totalmem: 4110323712
                              freemem: 198479872
                              cpus: 2
                            nodeVersion: v14.21.3
                            conns: 1
                          name: rocket.chat
                          pid: 1
                        broadcastAuth: true
                    success: true
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          $ref: '#/components/responses/forbiddenError'
      tags:
        - Instances
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      description: 'Get the instances running for the workspace. Permission required: `view-statistics`'
  /api/v1/federation/addServerByUser:
    parameters: []
    post:
      summary: Add Federated Server
      operationId: post-api-v1-federation-addServerByUser
      responses:
        '200':
          $ref: '#/components/responses/trueSuccess'
        '401':
          $ref: '#/components/responses/authorizationError'
      description: |-
        <div style="text-align: center; margin: 1rem 0 1rem 0;"><img src="https://raw.githubusercontent.com/RocketChat/Rocket.Chat-Open-API/main/images/premium.svg" alt="Premium tag" style="display: block; margin: auto;"></div>

        Add a new federated server.

        ### Changelog
        | Version      | Description |
        | ------------ | ------------|
        |6.0.0         | Added       |
      tags:
        - Federation
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                serverName:
                  type: string
                  description: The public server name.
              required:
                - serverName
            examples:
              Example:
                value:
                  serverName: my-server.rocket.chat
  /api/v1/federation/listServersByUser:
    parameters: []
    get:
      summary: Get Federated Servers
      operationId: get-api-v1-federation-listServersByUser
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  servers:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        default:
                          type: boolean
                        local:
                          type: boolean
                  success:
                    type: boolean
              examples:
                Success Example:
                  value:
                    servers:
                      - name: my-local.server
                        default: true
                        local: true
                      - name: matrix.org
                        default: true
                        local: false
                      - name: gitter.im
                        default: true
                        local: false
                      - name: libera.chat
                        default: true
                        local: false
                      - name: my-added-server.rocket.chat
                        default: false
                        local: false
                    success: true
        '401':
          $ref: '#/components/responses/authorizationError'
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      description: |-
        <div style="text-align: center; margin: 1rem 0 1rem 0;"><img src="https://raw.githubusercontent.com/RocketChat/Rocket.Chat-Open-API/main/images/premium.svg" alt="Premium tag" style="display: block; margin: auto;"></div>

        Lists all the servers the user has already saved.

        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |6.0.0            | Added       |
      tags:
        - Federation
  /api/v1/federation/removeServerByUser:
    parameters: []
    post:
      summary: Remove Federated Server
      operationId: post-api-v1-federation-removeServerByUser
      responses:
        '200':
          $ref: '#/components/responses/trueSuccess'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  error:
                    type: string
              examples:
                Example:
                  value:
                    success: false
                    error: cannot-remove-default-server
        '401':
          $ref: '#/components/responses/authorizationError'
      description: |-

        <div style="text-align: center; margin: 1rem 0 1rem 0;"><img src="https://raw.githubusercontent.com/RocketChat/Rocket.Chat-Open-API/main/images/premium.svg" alt="Premium tag" style="display: block; margin: auto;"></div>


        Remove a federated server.


        ### Changelog
        | Version      | Description |
        | ------------ | ------------|
        |6.0.0          Added       |
      tags:
        - Federation
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              x-examples:
                Example:
                  serverName: my-server.rocket.chat
              properties:
                serverName:
                  type: string
                  description: The public server name that you want to remove.
              required:
                - serverName
  /api/v1/federation/searchPublicRooms:
    parameters: []
    get:
      summary: Search Public Rooms
      operationId: get-api-v1-federation-searchPublicRooms
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  rooms:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        canJoin:
                          type: boolean
                        canonicalAlias:
                          type: string
                        joinedMembers:
                          type: integer
                        topic:
                          type: string
                  count:
                    type: integer
                  total:
                    type: integer
                  nextPageToken:
                    type: string
                  prevPageToken:
                    type: string
                  success:
                    type: boolean
              examples:
                Success Example:
                  value:
                    rooms:
                      - id: '!OGEhHVWSdvArJzumhm:matrix.org'
                        name: Matrix HQ
                        canJoin: true
                        canonicalAlias: '#matrix:matrix.org'
                        joinedMembers: 44461
                        topic: 'The Official Matrix HQ - chat about Matrix here! | https://matrix.org | https://spec.matrix.org | To support Matrix.org development: https://patreon.com/matrixdotorg | Code of Conduct: https://matrix.org/legal/code-of-conduct/ | This is an English speaking room'
                    count: 1
                    total: 73080
                    nextPageToken: g6FtzZa3oXK+IUpkemFiTlVQUFh6bENKQWhFbDpmYWJyaWMucHVioWTD
                    prevPageToken: g6FtzYqIoXK+IWNOd2pkUXdWcFJNc0lNa1VweDptYXRyaXgub3JnoWTC
                    success: true
        '401':
          $ref: '#/components/responses/authorizationError'
      description: |-
        <div style="text-align: center; margin: 1rem 0 1rem 0;"><img src="https://raw.githubusercontent.com/RocketChat/Rocket.Chat-Open-API/main/images/premium.svg" alt="Premium tag" style="display: block; margin: auto;"></div>

        Search for federated public rooms by the server name or room name.

        ### Changelog
        | Version      | Description |
        | ------------ | ------------|
        |6.0.0         | Added       |
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
        - schema:
            type: string
          example: matrix.org
          in: query
          name: serverName
          description: The server name.
          required: true
        - schema:
            type: string
          example: my public room name
          in: query
          name: roomName
          description: The room name you want to search for in the server.
        - schema:
            type: string
          example: g6FtzRlCoXK+IUpmS
          in: query
          name: pageToken
          description: 'The page you want to retrieve, use it for pagination. Make sure to URL encode this.'
        - $ref: '#/components/parameters/count'
      tags:
        - Federation
  /api/v1/federation/joinExternalPublicRoom:
    parameters: []
    post:
      summary: Join External Public Room
      operationId: post-api-v1-federation-joinExternalPublicRoom
      responses:
        '200':
          $ref: '#/components/responses/trueSuccess'
        '401':
          $ref: '#/components/responses/authorizationError'
      description: |-
        <div style="text-align: center; margin: 1rem 0 1rem 0;"><img src="https://raw.githubusercontent.com/RocketChat/Rocket.Chat-Open-API/main/images/premium.svg" alt="Premium tag" style="display: block; margin: auto;"></div>

        Join a public external federated room.

        ### Changelog
        | Version      | Description |
        | ------------ | ------------|
        |6.0.0         | Added       |
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                externalRoomId:
                  type: string
                  description: The external public room ID.
                  example: '!externalRoomId:server.com'
              required:
                - externalRoomId
            examples:
              Example:
                value:
                  externalRoomId: '!externalRoomId:server.com'
      tags:
        - Federation
  /api/v1/moderation.reportsByUsers:
    parameters: []
    get:
      summary: Get Reported Messages
      operationId: get-api-v1-moderation.reportsByUsers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  reports:
                    type: array
                    items:
                      type: object
                      properties:
                        rooms:
                          type: array
                          items:
                            type: object
                            properties:
                              _id:
                                type: string
                              t:
                                type: string
                              federated:
                                type: boolean
                        count:
                          type: integer
                        message:
                          type: string
                        msgId:
                          type: string
                        ts:
                          type: string
                        username:
                          type: string
                        name:
                          type: string
                        userId:
                          type: string
                        isUserDeleted:
                          type: boolean
                  count:
                    type: integer
                  offset:
                    type: integer
                  total:
                    type: integer
                  success:
                    type: boolean
              examples:
                Success Example:
                  value:
                    reports:
                      - rooms:
                          - _id: 6423ce62c29657e5b3ba2675rbAXPnMktTFbNpwtJ
                            t: d
                            federated: true
                        count: 1
                        message: hi
                        msgId: tDNLALSFk2LET2JZH
                        ts: '2023-08-30T09:38:38.792Z'
                        username: test.test
                        name: test test
                        userId: rbAXPnMktTFbNpwtJ
                        isUserDeleted: false
                      - rooms:
                          - _id: 5fRTXMt7DMJbpPJfhrbAXPnMktTFbNpwtJ
                            t: d
                        count: 2
                        message: himm
                        msgId: xY8cN7yuPQfBgJ9xz
                        ts: '2023-08-30T09:33:15.621Z'
                        username: test.test
                        name: Testtest
                        userId: 5fRTXMt7DMJbpPJfh
                        isUserDeleted: false
                    count: 2
                    offset: 0
                    total: 3
                    success: true
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          $ref: '#/components/responses/forbiddenError'
      description: |-
        Retrieves all the reported messages grouped by users.
        Permission required: `view-moderation-console`
        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |6.2.0            | Added       |
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
        - schema:
            type: string
          example: '2021-09-30T09:33:15.621Z'
          in: query
          name: oldest
          description: It represents the oldest point in time for which you want to retrieve moderation reports.
        - schema:
            type: string
          example: '2023-08-30T09:33:15.621Z'
          in: query
          name: latest
          description: It represents the oldest point in time for which you want to retrieve moderation reports.
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/count'
        - $ref: '#/components/parameters/sort'
      tags:
        - Moderation
  /api/v1/moderation.user.reportedMessages:
    parameters: []
    get:
      summary: Get User's Reported Messages
      operationId: get-api-v1-moderation.user.reportedMessages
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  user:
                    type: object
                    properties:
                      _id:
                        type: string
                      username:
                        type: string
                      name:
                        type: string
                  messages:
                    type: array
                    items:
                      type: object
                      properties:
                        _id:
                          type: string
                        message:
                          type: object
                          properties:
                            _id:
                              type: string
                            rid:
                              type: string
                            msg:
                              type: string
                            ts:
                              type: string
                            u:
                              type: object
                              properties:
                                _id:
                                  type: string
                                username:
                                  type: string
                                name:
                                  type: string
                            _updatedAt:
                              type: string
                            urls:
                              type: array
                              items:
                                type: object
                                properties: {}
                            mentions:
                              type: array
                              items:
                                type: object
                                properties: {}
                            channels:
                              type: array
                              items:
                                type: object
                                properties: {}
                            md:
                              type: array
                              items:
                                type: object
                                properties:
                                  type:
                                    type: string
                                  value:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        type:
                                          type: string
                                        value:
                                          type: string
                        room:
                          type: object
                          properties:
                            _id:
                              type: string
                            t:
                              type: string
                        ts:
                          type: string
                  count:
                    type: integer
                  total:
                    type: integer
                  offset:
                    type: integer
                  success:
                    type: boolean
              examples:
                Success Example:
                  value:
                    user:
                      _id: 5fRTXMt7DMJbpPJfh
                      username: test.test
                      name: Testtest
                    messages:
                      - _id: 64ef0f992c26843a68c1f785
                        message:
                          _id: EbhcT4vjrCDyZuHKq
                          rid: 5fRTXMt7DMJbpPJfhrbAXPnMktTFbNpwtJ
                          msg: hola
                          ts: '2023-08-30T09:44:30.805Z'
                          u:
                            _id: 5fRTXMt7DMJbpPJfh
                            username: test.test
                            name: Testtest
                          _updatedAt: '2023-08-30T09:44:30.968Z'
                          urls: []
                          mentions: []
                          channels: []
                          md:
                            - type: PARAGRAPH
                              value:
                                - type: PLAIN_TEXT
                                  value: hola
                        room:
                          _id: 5fRTXMt7DMJbpPJfhrbAXPnMktTFbNpwtJ
                          t: d
                        ts: '2023-08-30T09:44:57.912Z'
                      - _id: 64ef0cdb2c26843a68c1f780
                        message:
                          _id: xY8cN7yuPQfBgJ9xz
                          rid: 5fRTXMt7DMJbpPJfhrbAXPnMktTFbNpwtJ
                          msg: himm
                          ts: '2023-07-11T01:37:07.951Z'
                          u:
                            _id: 5fRTXMt7DMJbpPJfh
                            username: test.test
                            name: Testtest
                          _updatedAt: '2023-07-11T01:37:08.024Z'
                          urls: []
                          mentions: []
                          channels: []
                          md:
                            - type: PARAGRAPH
                              value:
                                - type: PLAIN_TEXT
                                  value: himm
                        room:
                          _id: 5fRTXMt7DMJbpPJfhrbAXPnMktTFbNpwtJ
                          t: d
                        ts: '2023-08-30T09:33:15.621Z'
                    count: 2
                    total: 2
                    offset: 0
                    success: true
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          $ref: '#/components/responses/forbiddenError'
      description: |-
        Retrieve all reported messages of a user.
        Permission required: `view-moderation-console`
        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |6.2.0            | Added       |
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/count'
        - $ref: '#/components/parameters/sort'
        - schema:
            type: string
          in: query
          description: The id of the user whose reported messages should be retrieved.
          name: userId
          required: true
      tags:
        - Moderation
  /api/v1/moderation.reports:
    parameters: []
    get:
      summary: Get Reports of a Message
      operationId: get-api-v1-moderation.reports
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  reports:
                    type: array
                    items:
                      type: object
                      properties:
                        _id:
                          type: string
                        description:
                          type: string
                        reportedBy:
                          type: object
                          properties:
                            _id:
                              type: string
                            username:
                              type: string
                            name:
                              type: string
                            createdAt:
                              type: string
                        room:
                          type: object
                          properties:
                            _id:
                              type: string
                            t:
                              type: string
                        ts:
                          type: string
                  count:
                    type: integer
                  offset:
                    type: integer
                  total:
                    type: integer
                  success:
                    type: boolean
              examples:
                Success Example:
                  value:
                    reports:
                      - _id: 64ef0f992c26843a68c1f785
                        description: |
                          test report
                        reportedBy:
                          _id: rbAXPnMktTFbNpwtJ
                          username: test.test
                          name: test test
                          createdAt: '2023-02-20T13:42:07.119Z'
                        room:
                          _id: 5fRTXMt7DMJbpPJfhrbAXPnMktTFbNpwtJ
                          t: d
                        ts: '2023-08-30T09:44:57.912Z'
                    count: 1
                    offset: 0
                    total: 1
                    success: true
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          $ref: '#/components/responses/forbiddenError'
      description: |-
        Retrieve all the reports of a single message. A message can have many reports.
        Permission required: `view-moderation-console`
        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |6.2.0            | Added       |
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/count'
        - $ref: '#/components/parameters/sort'
        - schema:
            type: string
          in: query
          description: The ID of the message to fetch reports for.
          name: msgId
          required: true
      tags:
        - Moderation
  /api/v1/moderation.reportInfo:
    parameters: []
    get:
      summary: Get Report Information
      operationId: get-api-v1-moderation.reportInfo
      responses:
        '200':
          $ref: '#/components/responses/trueSuccess'
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          $ref: '#/components/responses/forbiddenError'
      description: |-
        Get more details of a single report.
        Permission required: `view-moderation-console`
        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |6.2.0            | Added       |
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
        - schema:
            type: string
          in: query
          description: The ID of the report to fetch details for.
          name: reportId
          required: true
      tags:
        - Moderation
  /api/v1/moderation.dismissReports:
    parameters: []
    post:
      summary: Dismiss Reports
      operationId: post-api-v1-moderation.dismissReports
      responses:
        '200':
          $ref: '#/components/responses/trueSuccess'
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          $ref: '#/components/responses/forbiddenError'
      description: |-
        You can dismiss all the reports of a particular user by the `userId`. You can also dismiss the report of a message by the `msgId`.
        Permission required: `manage-moderation-actions`
        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |6.2.0            | Added       |
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                userId:
                  type: string
                  description: The ID of the user whose reports to dismiss. This parameter is required if `msgId` is not provided.
                msgId:
                  type: string
                  description: The ID of the message which reports to dismiss. This parameter is required if `userId` is not provided.
      tags:
        - Moderation
  /api/v1/moderation.user.deleteReportedMessages:
    post:
      summary: Delete Reported Messages of a User
      operationId: post-api-v1-moderation.user.deleteReportedMessages
      responses:
        '200':
          $ref: '#/components/responses/trueSuccess'
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          $ref: '#/components/responses/forbiddenError'
      description: |-
        Delete all the reports of messages that belongs to user. Permission required: `manage-moderation-actions`
        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |6.2.0            | Added       |
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                userId:
                  type: string
                  description: The ID of the user whose reports to dismiss.
              required:
                - userId
      tags:
        - Moderation
  /api/v1/moderation.dismissUserReports:
    post:
      summary: Dismiss User Reports
      tags:
        - Moderation
      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 'msgId'
                       must have required property 'userId'
                       must match exactly one schema in oneOf [invalid-params]
                    errorType: invalid-params
        '401':
          $ref: '#/components/responses/authorizationError'
      operationId: post-api-v1-moderation.dismissUserReports
      description: 'Dismiss a specific reported user from the list of reported users. Permission required: `manage-moderation-actions`'
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - userId
              properties:
                userId:
                  type: string
                  example: qHWhoJwwgk4bwcoNq
                  description: Enter the user ID of the reported user that you want to dismiss. Make sure that the ID belongs to the reported user.
                reason:
                  type: string
                  description: Enter a reason for dismissing the reported user.
            examples:
              Example 1:
                value:
                  userId: qHWhoJwwgk4bwcoNq
                  reason: Description
  /api/v1/moderation.user.reportsByUserId:
    get:
      summary: Get User Reports by User ID
      tags:
        - Moderation
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  user:
                    type: object
                    properties:
                      _id:
                        type: string
                      createdAt:
                        type: string
                      username:
                        type: string
                      emails:
                        type: array
                        items:
                          type: object
                          properties:
                            address:
                              type: string
                            verified:
                              type: boolean
                      roles:
                        type: array
                        items:
                          type: string
                      active:
                        type: boolean
                      name:
                        type: string
                      avatarETag:
                        type: string
                  reports:
                    type: array
                    items:
                      type: object
                      properties:
                        _id:
                          type: string
                        description:
                          type: string
                        reportedBy:
                          type: object
                          properties:
                            _id:
                              type: string
                            name:
                              type: string
                            username:
                              type: string
                            createdAt:
                              type: string
                        reportedUser:
                          type: object
                          properties:
                            _id:
                              type: string
                            createdAt:
                              type: string
                            username:
                              type: string
                            emails:
                              type: array
                              items:
                                type: object
                                properties:
                                  address:
                                    type: string
                                  verified:
                                    type: boolean
                            name:
                              type: string
                        ts:
                          type: string
                  count:
                    type: integer
                  total:
                    type: integer
                  offset:
                    type: integer
                  success:
                    type: boolean
              examples:
                Example 1:
                  value:
                    user:
                      _id: J6Q87AnWP5aNc9xhx
                      createdAt: '2025-02-04T13:02:39.356Z'
                      username: cat.kate
                      emails:
                        - address: testaz@example.com
                          verified: false
                      roles:
                        - user
                        - livechat-agent
                        - livechat-monitor
                      active: true
                      name: cat kate
                      avatarETag: pwJbBtoz47Zkf9myK
                    reports:
                      - _id: 6969ea608de1f4fa0e7f62fa
                        description: issue
                        reportedBy:
                          _id: C38WSSzrGd2NCjzqJ
                          name: test cat
                          username: test.cat
                          createdAt: null
                        reportedUser:
                          _id: J6Q87AnWP5aNc9xhx
                          createdAt: '2025-02-04T13:02:39.356Z'
                          username: cat.kate
                          emails:
                            - address: testaz@example.com
                              verified: false
                          name: cat kate
                        ts: '2026-01-16T07:36:00.020Z'
                    count: 1
                    total: 1
                    offset: 0
                    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 ''userId'' [invalid-params]'
                    errorType: invalid-params
        '401':
          $ref: '#/components/responses/authorizationError'
      operationId: get-api-v1-moderation.user.reportsByUserId
      description: 'Get the details of a specific user''s reports. Permission required: `view-moderation-console`'
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
        - schema:
            type: string
            example: Ahgf5k9Ca4YEdMjwX
          in: query
          name: userId
          description: Enter the user ID for which you want to retrieve the reports. Make sure that the user ID belongs to the user whose reports you want to retrieve. Entering a user ID with no reports returns the user details, and an incorrect ID returns null results.
          required: true
  /api/v1/moderation.userReports:
    get:
      summary: Get Reported Users
      tags:
        - Moderation
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  reports:
                    type: array
                    items:
                      type: object
                      properties:
                        count:
                          type: integer
                        reportedUser:
                          type: object
                          properties:
                            _id:
                              type: string
                            createdAt:
                              type: string
                            username:
                              type: string
                            emails:
                              type: array
                              items:
                                type: object
                                properties:
                                  address:
                                    type: string
                                  verified:
                                    type: boolean
                            name:
                              type: string
                        ts:
                          type: string
                  count:
                    type: integer
                  offset:
                    type: integer
                  total:
                    type: integer
                  success:
                    type: boolean
              examples:
                Example 1:
                  value:
                    reports:
                      - count: 1
                        reportedUser:
                          _id: J6Q87AnWP5aNc9xhx
                          createdAt: '2025-02-04T13:02:39.356Z'
                          username: cat.kate
                          emails:
                            - address: testaz@example.com
                              verified: false
                          name: cat kate
                        ts: '2026-01-16T07:36:00.020Z'
                    count: 1
                    offset: 0
                    total: 1
                    success: true
        '401':
          $ref: '#/components/responses/authorizationError'
      operationId: get-api-v1-moderation.userReports
      description: 'Get the list of reported users. Permission required: `view-moderation-console`'
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
  /api/v1/sessions/list:
    get:
      summary: Get Current User Sessions
      operationId: get-api-v1-sessions-list
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  sessions:
                    type: array
                    items:
                      type: object
                      properties:
                        sessionId:
                          type: string
                        userId:
                          type: string
                        device:
                          type: object
                          properties:
                            type:
                              type: string
                            name:
                              type: string
                            longVersion:
                              type: string
                            os:
                              type: object
                              properties:
                                name:
                                  type: string
                                version:
                                  type: string
                            version:
                              type: string
                        host:
                          type: string
                        ip:
                          type: string
                        loginAt:
                          type: string
                        _id:
                          type: string
                        current:
                          type: boolean
                          description: Whether the session belongs to the device making the request.  
                  total:
                    type: integer
                  count:
                    type: integer
                  offset:
                    type: integer
                  success:
                    type: boolean
              examples:
                Success Example:
                  value:
                    sessions:
                      - sessionId: QoYYFw2t9oKks2niG
                        userId: rbAXPnMktTFbNpwtJ
                        device:
                          type: browser
                          name: Chrome
                          longVersion: 113.0.0.0
                          os:
                            name: Windows
                            version: '10'
                          version: 113.0.0
                        host: 'localhost:3000'
                        ip: 172.20.0.2
                        loginAt: '2023-05-23T16:33:45.202Z'
                        _id: QoYYFw2t9oKks2niG
                        current: false
                      - sessionId: WJ2giBwm4B9mcojFi
                        userId: rbAXPnMktTFbNpwtJ
                        device:
                          type: mobile
                          name: Chrome
                          longVersion: 112.0.0.0
                          os:
                            name: Android
                            version: '10'
                          version: 112.0.0
                        host: 'localhost:3000'
                        ip: 172.20.0.2
                        loginAt: '2023-05-23T12:43:52.023Z'
                        _id: WJ2giBwm4B9mcojFi
                        current: false
                    total: 2
                    count: 50
                    offset: 0
                    success: true
        '401':
          $ref: '#/components/responses/authorizationError'
      description: |-
        <div style="text-align: center; margin: 1rem 0 1rem 0;"><img src="https://raw.githubusercontent.com/RocketChat/Rocket.Chat-Open-API/main/images/premium.svg" alt="Premium tag" style="display: block; margin: auto;"></div>

        Retrieves all sessions of the authenticated user making the request.

        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |5.0.0            | Added       |
      tags:
        - Device Management
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
        - schema:
            type: string
          example: windows
          in: query
          name: filter
          description: Filter sessions list using regex.
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/count'
        - $ref: '#/components/parameters/sort'
  /api/v1/sessions/list.all:
    parameters: []
    get:
      summary: Get All User Sessions
      operationId: get-api-v1-sessions-list.all
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  sessions:
                    type: array
                    items:
                      type: object
                      properties:
                        sessionId:
                          type: string
                        userId:
                          type: string
                        device:
                          type: object
                          properties:
                            type:
                              type: string
                            name:
                              type: string
                            longVersion:
                              type: string
                            os:
                              type: object
                              properties:
                                name:
                                  type: string
                                version:
                                  type: string
                            version:
                              type: string
                        host:
                          type: string
                        ip:
                          type: string
                        loginAt:
                          type: string
                        _user:
                          type: object
                          properties:
                            username:
                              type: string
                            name:
                              type: string
                        _id:
                          type: string
                  total:
                    type: integer
                  count:
                    type: integer
                  offset:
                    type: integer
                  success:
                    type: boolean
              examples:
                Success:
                  value:
                    sessions:
                      - sessionId: o94SveQp6fyPsoiNC
                        userId: 2tTEqR7ZNMJ4HGGNa
                        device:
                          type: browser
                          name: Chrome
                          longVersion: 113.0.0.0
                          os:
                            name: Windows
                            version: '10'
                          version: 113.0.0
                        host: 'localhost:3000'
                        ip: 172.20.0.2
                        loginAt: '2023-05-24T00:25:54.234Z'
                        _user:
                          username: testroxie
                          name: Test
                        _id: o94SveQp6fyPsoiNC
                      - sessionId: BdSrCZXNKCbRi8Eqn
                        userId: rbAXPnMktTFbNpwtJ
                        device:
                          type: browser
                          name: Chrome
                          longVersion: 113.0.0.0
                          os:
                            name: Windows
                            version: '10'
                          version: 113.0.0
                        host: 'localhost:3000'
                        ip: 172.20.0.2
                        loginAt: '2023-05-24T00:25:52.246Z'
                        _user:
                          username: test.test
                          name: test test
                        _id: BdSrCZXNKCbRi8Eqn
                      - sessionId: tTouumJMrHMjnedWf
                        userId: GonjPyg3gB3Z9ur9s
                        device:
                          type: browser
                          name: Chrome
                          longVersion: 113.0.0.0
                          os:
                            name: Windows
                            version: '10'
                          version: 113.0.0
                        host: 'localhost:3000'
                        ip: 172.20.0.2
                        loginAt: '2023-05-23T19:14:29.865Z'
                        _user:
                          name: test
                          username: test.test
                        _id: tTouumJMrHMjnedWf
                      - sessionId: 7ykYEK3KWnk4EeA7s
                        userId: 2tTEqR7ZNMJ4HGGNa
                        device:
                          type: browser
                          name: Chrome
                          longVersion: 113.0.0.0
                          os:
                            name: Windows
                            version: '10'
                          version: 113.0.0
                        host: 'localhost:3000'
                        ip: 172.20.0.2
                        loginAt: '2023-05-23T19:14:28.717Z'
                        _user:
                          username: testroxie
                          name: Test
                        _id: 7ykYEK3KWnk4EeA7s
                      - sessionId: jfD6mnHnrEJdPq9MF
                        userId: stjxrXYBWy3EcDugH
                        device:
                          type: browser
                          name: Chrome
                          longVersion: 113.0.0.0
                          os:
                            name: Windows
                            version: '10'
                          version: 113.0.0
                        host: 'localhost:3000'
                        ip: 172.20.0.2
                        loginAt: '2023-05-23T15:21:57.188Z'
                        _user:
                          username: rocket.agent
                          name: Rocket Agent
                        _id: jfD6mnHnrEJdPq9MF
                      - sessionId: 2jQnfG74X3EZYL9tj
                        userId: rYhzFRd2QZjNwAAXX
                        device:
                          type: browser
                          name: Chrome
                          longVersion: 113.0.0.0
                          os:
                            name: Windows
                            version: '10'
                          version: 113.0.0
                        host: 'localhost:3000'
                        ip: 172.20.0.2
                        loginAt: '2023-05-23T15:19:48.723Z'
                        _user:
                          name: Rodriq
                          username: rodriq
                        _id: 2jQnfG74X3EZYL9tj
                      - sessionId: fsfE772s78AmPxGKk
                        userId: uZ5JvvioeHK8Coyqe
                        device:
                          type: browser
                          name: Firefox
                          longVersion: '112.0'
                          os:
                            name: Windows
                            version: '10'
                          version: '112.0'
                        host: 'localhost:3000'
                        ip: 172.18.0.4
                        loginAt: '2023-05-16T20:50:33.608Z'
                        _user:
                          username: user-0
                        _id: fsfE772s78AmPxGKk
                      - sessionId: W4y9xkjyqFvbjENco
                        userId: b66oZ8i9pkeSko33v
                        device:
                          type: browser
                          name: Chrome
                          longVersion: 113.0.0.0
                          os:
                            name: Windows
                            version: '10'
                          version: 113.0.0
                        host: 'localhost:3000'
                        ip: 172.18.0.4
                        loginAt: '2023-05-16T12:46:09.469Z'
                        _user:
                          username: guester
                          name: Guester
                        _id: W4y9xkjyqFvbjENco
                      - sessionId: 94yTWFkADGBvE9t7P
                        userId: aspKK7FHe7iQgzexX
                        device:
                          type: browser
                          name: Firefox
                          longVersion: '112.0'
                          os:
                            name: Windows
                            version: '10'
                          version: '112.0'
                        host: 'localhost:3000'
                        ip: 172.18.0.4
                        loginAt: '2023-05-11T18:47:13.865Z'
                        _user:
                          username: user-00
                          name: User 00
                        _id: 94yTWFkADGBvE9t7P
                    total: 13
                    count: 50
                    offset: 0
                    success: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  error:
                    type: string
                  errorType:
                    type: string
                  details:
                    type: object
                    properties:
                      method:
                        type: string
                      codeGenerated:
                        type: boolean
                      availableMethods:
                        type: array
                        items:
                          type: object
                          properties: {}
              examples:
                TOTP Error:
                  value:
                    success: false
                    error: 'TOTP Required [totp-required]'
                    errorType: totp-required
                    details:
                      method: password
                      codeGenerated: false
                      availableMethods: []
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          $ref: '#/components/responses/forbiddenError'
      description: |-
        <div style="text-align: center; margin: 1rem 0 1rem 0;"><img src="https://raw.githubusercontent.com/RocketChat/Rocket.Chat-Open-API/main/images/premium.svg" alt="Premium tag" style="display: block; margin: auto;"></div>

        Retrieve the sessions of all users on the workspace. This endpoint requires 2FA.
        Permission required: `view-device-management`

        ### Changelog
        | Version      | Description |
        | ------------ | ------------|
        |5.0.0         | Added       |
      tags:
        - Device Management
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
        - schema:
            type: string
          example: windows
          in: query
          name: filter
          description: Filter sessions list using regex.
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/count'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/x-2fa-code'
        - $ref: '#/components/parameters/X-2fa-method'
  /api/v1/sessions/info:
    parameters: []
    get:
      summary: Get Current User Session Information
      operationId: get-api-v1-sessions-info
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  _id:
                    type: string
                  type:
                    type: string
                  sessionId:
                    type: string
                  instanceId:
                    type: string
                  loginToken:
                    type: string
                  ip:
                    type: string
                  host:
                    type: string
                  device:
                    type: object
                    properties:
                      type:
                        type: string
                      name:
                        type: string
                      longVersion:
                        type: string
                      os:
                        type: object
                        properties:
                          name:
                            type: string
                          version:
                            type: string
                      version:
                        type: string
                  userId:
                    type: string
                  roles:
                    type: array
                    items:
                      type: string
                  mostImportantRole:
                    type: string
                  loginAt:
                    type: string
                  day:
                    type: integer
                  month:
                    type: integer
                  year:
                    type: integer
                  searchTerm:
                    type: string
                  createdAt:
                    type: string
                  _updatedAt:
                    type: string
                  closedAt:
                    type: string
                  lastActivityAt:
                    type: string
                  success:
                    type: boolean
              examples:
                Success Example:
                  value:
                    _id: 646ceae9a8c3a3ba32d0e897
                    type: session
                    sessionId: QoYYFw2t9oKks2niG
                    instanceId: f0313fa9-ebe6-4a84-8580-3104f6a09988
                    loginToken: orklPYtfnjnG6mG7OMuLbOBDzs8I9myfcLl2yzv7WoU=
                    ip: 172.20.0.2
                    host: 'localhost:3000'
                    device:
                      type: browser
                      name: Chrome
                      longVersion: 113.0.0.0
                      os:
                        name: Windows
                        version: '10'
                      version: 113.0.0
                    userId: rbAXPnMktTFbNpwtJ
                    roles:
                      - user
                      - admin
                      - livechat-agent
                      - livechat-manager
                    mostImportantRole: admin
                    loginAt: '2023-05-23T16:33:45.202Z'
                    day: 23
                    month: 5
                    year: 2023
                    searchTerm: ChromebrowserWindowsQoYYFw2t9oKks2niGrbAXPnMktTFbNpwtJ
                    createdAt: '2023-05-23T16:33:45.203Z'
                    _updatedAt: '2023-05-23T17:56:31.599Z'
                    closedAt: '2023-05-23T17:56:31.599Z'
                    lastActivityAt: '2023-05-23T17:56:31.599Z'
                    success: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  error:
                    type: string
              examples:
                Session not found:
                  value:
                    success: false
                    error: Session not found
        '401':
          $ref: '#/components/responses/authorizationError'
      description: |-
        <div style="text-align: center; margin: 1rem 0 1rem 0;"><img src="https://raw.githubusercontent.com/RocketChat/Rocket.Chat-Open-API/main/images/premium.svg" alt="Premium tag" style="display: block; margin: auto;"></div>

        Retrieve session information for sessions owned by the authenticated user. This endpoint provides detailed information about the user's sessions on the workspace. It does not grant access to the session information of other users on the workspace.

        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |5.0.0            | Added       |
      tags:
        - Device Management
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
        - schema:
            type: string
          example: windows
          in: query
          name: sessionId
          description: The session ID.
          required: true
  /api/v1/sessions/info.admin:
    parameters: []
    get:
      summary: Get Session Information
      operationId: get-api-v1-sessions-info.admin
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  sessionId:
                    type: string
                  userId:
                    type: string
                  device:
                    type: object
                    properties:
                      type:
                        type: string
                      name:
                        type: string
                      longVersion:
                        type: string
                      os:
                        type: object
                        properties:
                          name:
                            type: string
                          version:
                            type: string
                      version:
                        type: string
                  host:
                    type: string
                  ip:
                    type: string
                  loginAt:
                    type: string
                  _user:
                    type: object
                    properties:
                      name:
                        type: string
                      username:
                        type: string
                  _id:
                    type: string
                  success:
                    type: boolean
              examples:
                Success Example:
                  value:
                    sessionId: uBNL9dTjJ4s6Pjp4K
                    userId: rYhzFRd2QZjNwAAXX
                    device:
                      type: browser
                      name: Chrome
                      longVersion: 113.0.0.0
                      os:
                        name: Windows
                        version: '10'
                      version: 113.0.0
                    host: 'localhost:3000'
                    ip: 172.20.0.2
                    loginAt: '2023-05-24T05:08:42.806Z'
                    _user:
                      name: Rod
                      username: Rod
                    _id: uBNL9dTjJ4s6Pjp4K
                    success: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  error:
                    type: string
              examples:
                Session not found:
                  value:
                    success: false
                    error: Session not found
                TOTP Error:
                  value:
                    success: false
                    error: 'TOTP Required [totp-required]'
                    errorType: totp-required
                    details:
                      method: password
                      codeGenerated: false
                      availableMethods: []
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          $ref: '#/components/responses/forbiddenError'
      description: |-
        <div style="text-align: center; margin: 1rem 0 1rem 0;"><img src="https://raw.githubusercontent.com/RocketChat/Rocket.Chat-Open-API/main/images/premium.svg" alt="Premium tag" style="display: block; margin: auto;"></div>

        Retrieve session information for any session on the workspace, regardless of the session owner. This endpoint allows authorized users to access session details across the workspace and requires 2FA.
        Permission required: `view-device-management`

        ### Changelog
        | Version      | Description |
        | ------------ | ------------|
        |5.0.0         | Added       |
      tags:
        - Device Management
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
        - schema:
            type: string
          example: windows
          in: query
          name: sessionId
          description: The session ID.
          required: true
        - $ref: '#/components/parameters/x-2fa-code'
        - $ref: '#/components/parameters/X-2fa-method'
  /api/v1/sessions/logout.me:
    parameters: []
    post:
      summary: Logout Current User Session
      operationId: post-api-v1-sessions-logout.me
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  sessionId:
                    type: string
                  success:
                    type: boolean
              examples:
                Success Example:
                  value:
                    sessionId: WJ2giBwm4B9mcojFi
                    success: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  error:
                    type: string
              examples:
                Session not found:
                  value:
                    success: false
                    error: Session not found
        '401':
          $ref: '#/components/responses/authorizationError'
      description: |-
        <div style="text-align: center; margin: 1rem 0 1rem 0;"><img src="https://raw.githubusercontent.com/RocketChat/Rocket.Chat-Open-API/main/images/premium.svg" alt="Premium tag" style="display: block; margin: auto;"></div>

        This endpoint allows an authenticated user to log out of any of their sessions on the workspace. It is designed specifically for the user to terminate their sessions and cannot be used to log out sessions belonging to other users on the workspace.

        ### Changelog
        | Version      | Description |
        | ---------------- | ------------|
        |5.0.0            | Added       |
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      tags:
        - Device Management
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                sessionId:
                  type: string
                  description: The session ID.
              required:
                - sessionId
            examples:
              Example:
                value:
                  sessionId: WJ2giBwm4B9mcojFi
  /api/v1/sessions/logout:
    parameters: []
    post:
      summary: Logout Session
      operationId: post-api-v1-sessions-logout
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  sessionId:
                    type: string
                  success:
                    type: boolean
              examples:
                Success Example:
                  value:
                    sessionId: tTouumJMrHMjnedWf
                    success: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  error:
                    type: string
                  errorType:
                    type: string
                  details:
                    type: object
                    properties:
                      method:
                        type: string
                      codeGenerated:
                        type: boolean
                      availableMethods:
                        type: array
                        items:
                          type: object
                          properties: {}
              examples:
                TOTP Error:
                  value:
                    success: false
                    error: 'TOTP Required [totp-required]'
                    errorType: totp-required
                    details:
                      method: password
                      codeGenerated: false
                      availableMethods: []
        '401':
          $ref: '#/components/responses/authorizationError'
        '403':
          $ref: '#/components/responses/forbiddenError'
      description: |-
        <div style="text-align: center; margin: 1rem 0 1rem 0;"><img src="https://raw.githubusercontent.com/RocketChat/Rocket.Chat-Open-API/main/images/premium.svg" alt="Premium tag" style="display: block; margin: auto;"></div>

        This endpoint allows an authorized user to log out other user's session on the workspace and requires 2FA. It provides the capability to terminate sessions of other users, ensuring workspace security and management.

        Permission required: `logout-device-management`

        ### Changelog
        | Version      | Description |
        | ------------ | ------------|
        |5.0.0         | Added       |
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
        - $ref: '#/components/parameters/x-2fa-code'
        - $ref: '#/components/parameters/X-2fa-method'
      tags:
        - Device Management
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                sessionId:
                  type: string
                  description: The session ID.
              required:
                - sessionId
  /api/v1/pw.getPolicy:
    get:
      summary: Get Password Policy
      tags:
        - Password policy
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties: {}
              examples:
                Success:
                  value:
                    enabled: true
                    policy:
                      - - get-password-policy-minLength
                        - minLength: 7
                      - - get-password-policy-forbidRepeatingCharacters
                      - - get-password-policy-forbidRepeatingCharactersCount
                        - forbidRepeatingCharactersCount: 3
                      - - get-password-policy-mustContainAtLeastOneLowercase
                      - - get-password-policy-mustContainAtLeastOneUppercase
                      - - get-password-policy-mustContainAtLeastOneNumber
                      - - get-password-policy-mustContainAtLeastOneSpecialCharacter
                    success: true
      operationId: get-pw.getPolicy
      description: |-
        Get the current [password policy](https://docs.rocket.chat/v1/docs/accounts#password-policy) for users in your workspace.
        The `pw.getPolicyReset` endpoint has been removed from 7.0. Use this endpoint instead.
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
  /api/v1/video-conference.capabilities:
    get:
      summary: Get Video Conference Capabilities
      tags:
        - Video Conference
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  providerName:
                    type: string
                  capabilities:
                    type: object
                    properties:
                      mic:
                        type: boolean
                      cam:
                        type: boolean
                      title:
                        type: boolean
                  success:
                    type: boolean
              examples:
                Example 1:
                  value:
                    providerName: googlemeet
                    capabilities:
                      mic: false
                      cam: false
                      title: false
                    success: true
                Example 2:
                  value:
                    providerName: jitsi
                    capabilities:
                      mic: true
                      cam: true
                      title: true
                    success: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  error:
                    type: string
              examples:
                Example 1:
                  value:
                    success: false
                    error: no-active-video-conf-provider
        '401':
          $ref: '#/components/responses/authorizationError'
      operationId: get-api-v1-video-conference.capabilities
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      description: |-
       Get details on the video call capabilities, such as the name of the provider, and whether Rocket.Chat can control the microphone and camera state. This endpoint is used for the video conference system to dynamically adapt the UI based on provider capabilities, ensuring users only see controls that are actually supported by the configured video conference provider.
       
       Rate limiting: 3 requests per 1000ms
  /api/v1/video-conference.list:
    get:
      summary: Get List of Video Conferences
      tags:
        - Video Conference
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        _id:
                          type: string
                        type:
                          type: string
                        users:
                          type: array
                          items:
                            type: object
                            properties:
                              _id:
                                type: string
                              username:
                                type: string
                              name:
                                type: string
                              avatarETag:
                                type: string
                              ts:
                                type: string
                        messages:
                          type: object
                          properties:
                            started:
                              type: string
                        status:
                          type: integer
                        anonymousUsers:
                          type: integer
                        createdAt:
                          type: string
                        providerName:
                          type: string
                        ringing:
                          type: boolean
                        title:
                          type: string
                        rid:
                          type: string
                        createdBy:
                          type: object
                          properties:
                            _id:
                              type: string
                            name:
                              type: string
                            username:
                              type: string
                        _updatedAt:
                          type: string
                        url:
                          type: string
                        endedAt:
                          type: string
                  offset:
                    type: integer
                  count:
                    type: integer
                  total:
                    type: integer
                  success:
                    type: boolean
              examples:
                Example 1:
                  value:
                    data:
                      - _id: 69786d0ac8b05330207814bd
                        type: videoconference
                        users:
                          - _id: fRv4qm8ycWHXSA7af
                            username: jane.doe
                            name: jane
                            avatarETag: null
                            ts: '2026-01-27T07:45:14.977Z'
                        messages:
                          started: 8AqsmsMXDePKfDbHv
                        status: 1
                        anonymousUsers: 0
                        createdAt: '2026-01-27T07:45:14.533Z'
                        providerName: googlemeet
                        ringing: true
                        title: ui-test
                        rid: 674eca3e43725ce31dd9a2e8
                        createdBy:
                          _id: fRv4qm8ycWHXSA7af
                          name: jane
                          username: jane.doe
                        _updatedAt: '2026-01-27T07:45:14.977Z'
                        url: 'http://g.co/meet/RocketChat_69786d0ac8b05330207814bd'
                      - _id: 6772586c8dd061cca4edc998
                        type: videoconference
                        users:
                          - _id: fRv4qm8ycWHXSA7af
                            username: jane.doe
                            name: jane
                            ts: '2024-12-30T08:23:11.130Z'
                        messages:
                          started: sTDmP2WSH6Rwt89iw
                        status: 2
                        anonymousUsers: 0
                        createdAt: '2024-12-30T08:23:08.655Z'
                        providerName: jitsi
                        rid: 674eca3e43725ce31dd9a2e8
                        title: ui-test
                        createdBy:
                          _id: fRv4qm8ycWHXSA7af
                          name: jane
                          username: jane.doe
                        _updatedAt: '2024-12-31T09:00:00.025Z'
                        url: 'https://meet.jit.si/RocketChat6772586c8dd061cca4edc998'
                        endedAt: '2024-12-31T09:00:00.025Z'
                    offset: 0
                    count: 2
                    total: 2
                    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 ''roomId'' [invalid-params]'
                    errorType: invalid-params
        '401':
          $ref: '#/components/responses/authorizationError'
      operationId: get-api-v1-video-conference.list
      description: 'Use this endpoint to get the list of video calls for a specific room. Rate limiting: 3 requests per 1000ms.'
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
        - schema:
            type: string
            example: 674eca3e43725ce31dd9a2e8
          in: query
          name: roomId
          description: Enter the room ID for which you want to view the list of video conferences. Make sure that you have access to the room.
          required: true
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/count'
  /api/v1/video-conference.info:
    get:
      summary: Get Video Conference Details
      tags:
        - Video Conference
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  _id:
                    type: string
                  type:
                    type: string
                  users:
                    type: array
                    items:
                      type: object
                      properties:
                        _id:
                          type: string
                        username:
                          type: string
                        name:
                          type: string
                        avatarETag:
                          type: string
                        ts:
                          type: string
                  messages:
                    type: object
                    properties:
                      started:
                        type: string
                  status:
                    type: integer
                  anonymousUsers:
                    type: integer
                  createdAt:
                    type: string
                  providerName:
                    type: string
                  ringing:
                    type: boolean
                  title:
                    type: string
                  rid:
                    type: string
                  createdBy:
                    type: object
                    properties:
                      _id:
                        type: string
                      name:
                        type: string
                      username:
                        type: string
                  _updatedAt:
                    type: string
                  url:
                    type: string
                  capabilities:
                    type: object
                    properties:
                      mic:
                        type: boolean
                      cam:
                        type: boolean
                      title:
                        type: boolean
                  success:
                    type: boolean
              examples:
                Example 1:
                  value:
                    _id: 697866d5c8b053302078137a
                    type: videoconference
                    users:
                      - _id: fRv4qm8ycWHXSA7af
                        username: jane.doe
                        name: jane
                        avatarETag: null
                        ts: '2026-01-27T07:18:46.491Z'
                    messages:
                      started: RdiQLFktbFxtK2XTZ
                    status: 1
                    anonymousUsers: 0
                    createdAt: '2026-01-27T07:18:45.956Z'
                    providerName: googlemeet
                    ringing: true
                    title: testdiscussion
                    rid: 68c8071650223764573dd2dc
                    createdBy:
                      _id: fRv4qm8ycWHXSA7af
                      name: jane
                      username: jane.doe
                    _updatedAt: '2026-01-27T07:18:46.491Z'
                    url: 'http://g.co/meet/RocketChat_697866d5c8b053302078137a'
                    capabilities:
                      mic: false
                      cam: false
                      title: false
                    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 ''callId'' [invalid-params]'
                    errorType: invalid-params
        '401':
          $ref: '#/components/responses/authorizationError'
      operationId: get-api-v1-video-conference.info
      description: 'Get details about a specific video conference. Rate limiting: 15 requests per 3000ms.'
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
        - schema:
            type: string
            example: 697866d5c8b053302078137a
          in: query
          name: callId
          description: Enter the call ID.
          required: true
  /api/v1/video-conference.providers:
    get:
      summary: Get Video Conference Providers
      tags:
        - Video Conference
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                        label:
                          type: string
                  success:
                    type: boolean
              examples:
                Example 1:
                  value:
                    data:
                      - key: pexip
                        label: Pexip
                      - key: googlemeet
                        label: GoogleMeet
                    success: true
        '401':
          $ref: '#/components/responses/authorizationError'
      operationId: get-api-v1-video-conference.providers
      description: 'Get the list of available video conference providers in your workspace, regardless of their active status. Rate limiting: 3 requests per 1000ms.'
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
  /api/v1/video-conference.start:
    post:
      summary: Start Video Conference
      tags:
        - Video Conference
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      type:
                        type: string
                      callId:
                        type: string
                      rid:
                        type: string
                      providerName:
                        type: string
                  success:
                    type: boolean
              examples:
                Example 1:
                  value:
                    data:
                      type: videoconference
                      callId: 697887e3c8b0533020781a4a
                      rid: 674eca3e43725ce31dd9a2e8
                      providerName: googlemeet
                    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 ''roomId'' [invalid-params]'
                    errorType: invalid-params
        '401':
          $ref: '#/components/responses/authorizationError'
      operationId: post-api-v1-video-conference.start
      description: 'Use this endpoint to begin a video call in a specific room. Rate limiting: 3 requests per 60000ms. Permission required: `call-management`.'
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - roomId
              properties:
                roomId:
                  type: string
                  description: Enter the room ID where you want to start the video call.
                  example: 674eca3e43725ce31dd9a2e8
                title:
                  type: string
                  description: Enter a title for the video call.
                allowRinging:
                  type: boolean
                  description: 'Whether to enable ringing for direct calls (requires `videoconf-ring-users` permission; by default admin, users, moderators, and owners have this permission).'
            examples:
              Example 1:
                value:
                  roomId: 674eca3e43725ce31dd9a2e8
                  title: Test Call
                  allowRinging: true
  /api/v1/video-conference.join:
    post:
      summary: Join a Video Conference
      tags:
        - Video Conference
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
                  providerName:
                    type: string
                  success:
                    type: boolean
              examples:
                Example 1:
                  value:
                    url: 'http://g.co/meet/RocketChat_697887e3c8b0533020781a4a'
                    providerName: googlemeet
                    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 ''callId'' [invalid-params]'
                    errorType: invalid-params
        '401':
          $ref: '#/components/responses/authorizationError'
      operationId: post-api-v1-video-conference.join
      description: 'Join a specific video conference. Rate limiting: 2 requests per 5000ms. This endpoint also allows anonymous access for guest users.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - callId
              properties:
                callId:
                  type: string
                  example: 697887e3c8b0533020781a4a
                  description: Enter the video conference call ID that you want to join.
                state:
                  type: object
                  description: Object containing initial device states.
                  properties:
                    mic:
                      type: boolean
                      description: Whether the microphone starts muted or unmuted.
                    cam:
                      type: boolean
                      description: Whether the camera starts enabled or disabled.
            examples:
              Example 1:
                value:
                  callId: 697887e3c8b0533020781a4a
                  state:
                    mic: true
                    cam: true
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
  /api/v1/video-conference.cancel:
    post:
      summary: Cancel Video Conference
      tags:
        - Video Conference
      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 ''callId'' [invalid-params]'
                    errorType: invalid-params
                Example 2:
                  value:
                    success: false
                    error: invalid-call
        '401':
          $ref: '#/components/responses/authorizationError'
      operationId: post-api-v1-video-conference.cancel
      description: "Cancel a specific video conference call. You can only cancel a call that is in the calling state. Rate limiting: 3 requests per 60 seconds."
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - callId
              properties:
                callId:
                  type: string
                  example: 697887e3c8b0533020781a4a
                  description: Enter the call ID that you want to cancel.
  /media-calls.state:
    get:
      tags:
        - Media Calls
      summary: Get Current Media Call State
      description: |
        Returns every media call the authenticated user is part of and that has
        not yet ended. Each entry reflects the call's latest
        server-side state — `ringing`, `active`, etc. It also includes the
        caller, callee, supported features, and lifecycle timestamps.
      operationId: post-api-v1-get-media-calls.state
      parameters:
        - $ref: '#/components/parameters/X-User-Id'
        - $ref: '#/components/parameters/X-Auth-Token'
      responses:
        "200":
          description: The list of in-flight calls for the authenticated user.
          content:
            application/json:
              schema:
                type: object
                properties:
                  calls:
                    type: array
                    description: All in-flight calls the authenticated user participates in.
                    items:
                      type: object
                      properties:
                        _id:
                          type: string
                          format: uuid
                          description: Unique identifier of the call.
                          example: 9f44ec94-2046-4fac-976b-fa8b0e022b08
                        service:
                          type: string
                          enum: [webrtc]
                          description: Underlying media service powering the call.
                          example: webrtc
                        kind:
                          type: string
                          enum: [direct]
                          description: Call topology.
                          example: direct
                        state:
                          type: string
                          enum: [ringing, active]
                          description: |
                            Current lifecycle state of the call.
                            - `ringing` : invitation sent, callee has not yet answered.
                            - `active` : call accepted and media is flowing.
                          example: ringing
                        createdBy:
                          type: object
                          description: The actor who created the call.
                          properties:
                            type:
                              type: string
                              example: user
                            id:
                              type: string
                              description: Rocket.Chat user id.
                              example: aEGCdnFoBFCFNdiyX
                            contractId:
                              type: string
                              format: uuid
                              description: Device/session contract id registered with the media-call service.
                              example: 7b96e74d-1e01-412a-8bcb-145db1bc9ac4
                        createdAt:
                          type: string
                          format: date-time
                          description: When the call record was created on the server.
                          example: "2026-04-30T13:30:53.165Z"
                        caller:
                          type: object
                          description: The party initiating the call. Always carries `contractId`.
                          properties:
                            type:
                              type: string
                              example: user
                            id:
                              type: string
                              example: aEGCdnFoBFCFNdiyX
                            contractId:
                              type: string
                              example: 7b96e74d-1e01-412a-8bcb-145db1bc9ac4
                            displayName:
                              type: string
                              example: Funke Olasupo
                            username:
                              type: string
                              example: funke.olasupo
                        callee:
                          type: object
                          description: |
                            The party being called. `contractId` is omitted while
                            the call is `ringing` (no device has answered yet)
                            and populated once accepted.
                          properties:
                            type:
                              type: string
                              example: user
                            id:
                              type: string
                              example: iaZWAXecuCuBx4FnX
                            contractId:
                              type: string
                              description: Set once the call is accepted.
                              example: 7488b84e-e096-46fb-8d62-1e6e3db479c9
                            displayName:
                              type: string
                              example: Agent1
                            username:
                              type: string
                              example: agent1
                        expiresAt:
                          type: string
                          description: When the current state will expire if no further activity occurs.
                          example: "2026-04-30T13:33:12.993Z"
                        uids:
                          type: array
                          description: User IDs of every participant in the call.
                          items:
                            type: string
                          example:
                            - aEGCdnFoBFCFNdiyX
                            - iaZWAXecuCuBx4FnX
                        ended:
                          type: boolean
                          description: Always `false` for entries returned by this endpoint.
                          example: false
                        callerRequestedId:
                          type: string
                          description: Client-supplied correlation id for the call request.
                          example: 7b96e74d-1e01-412a-8bcb-145db1bc9ac4-38b61a15-8c41-4ee4-be75-977c48cd94ea
                        features:
                          type: array
                          description: Feature flags negotiated for this call.
                          items:
                            type: string
                          example: [audio, screen-share, transfer, hold]
                        _updatedAt:
                          type: string
                          description: When the call record was last updated.
                          example: "2026-04-30T13:31:12.993Z"
                        acceptedAt:
                          type: string
                          description: Set once the callee accepts. Absent while ringing.
                          example: "2026-04-30T13:31:10.070Z"
                        activatedAt:
                          type: string
                          description: Set once media becomes active. Absent while ringing.
                          example: "2026-04-30T13:31:12.698Z"
                  success:
                    type: boolean
                    example: true
              examples:
                ringing:
                  summary: Outbound call is still ringing
                  value:
                    calls:
                      - _id: 9f44ec94-2046-4fac-976b-fa8b0e022b08
                        service: webrtc
                        kind: direct
                        state: ringing
                        createdBy:
                          type: user
                          id: aEGCdnFoBFCFNdiyX
                          contractId: 7b96e74d-1e01-412a-8bcb-145db1bc9ac4
                        createdAt: "2026-04-30T13:30:53.165Z"
                        caller:
                          type: user
                          id: aEGCdnFoBFCFNdiyX
                          contractId: 7b96e74d-1e01-412a-8bcb-145db1bc9ac4
                          displayName: Funke Olasupo
                          username: funke.olasupo
                        callee:
                          type: user
                          id: iaZWAXecuCuBx4FnX
                          displayName: Agent1
                          username: agent1
                        expiresAt: "2026-04-30T13:33:02.878Z"
                        uids: [aEGCdnFoBFCFNdiyX, iaZWAXecuCuBx4FnX]
                        ended: false
                        callerRequestedId: 7b96e74d-1e01-412a-8bcb-145db1bc9ac4-38b61a15-8c41-4ee4-be75-977c48cd94ea
                        features: [audio, screen-share, transfer, hold]
                        _updatedAt: "2026-04-30T13:31:02.878Z"
                    success: true
                active:
                  summary: Call has been picked up and is active
                  value:
                    calls:
                      - _id: 9f44ec94-2046-4fac-976b-fa8b0e022b08
                        service: webrtc
                        kind: direct
                        state: active
                        createdBy:
                          type: user
                          id: aEGCdnFoBFCFNdiyX
                          contractId: 7b96e74d-1e01-412a-8bcb-145db1bc9ac4
                        createdAt: "2026-04-30T13:30:53.165Z"
                        caller:
                          type: user
                          id: aEGCdnFoBFCFNdiyX
                          contractId: 7b96e74d-1e01-412a-8bcb-145db1bc9ac4
                          displayName: Funke Olasupo
                          username: funke.olasupo
                        callee:
                          type: user
                          id: iaZWAXecuCuBx4FnX
                          contractId: 7488b84e-e096-46fb-8d62-1e6e3db479c9
                          displayName: Agent1
                          username: agent1
                        expiresAt: "2026-04-30T13:33:12.993Z"
                        uids: [aEGCdnFoBFCFNdiyX, iaZWAXecuCuBx4FnX]
                        ended: false
                        callerRequestedId: 7b96e74d-1e01-412a-8bcb-145db1bc9ac4-38b61a15-8c41-4ee4-be75-977c48cd94ea
                        features: [audio, screen-share, transfer, hold]
                        _updatedAt: "2026-04-30T13:31:12.993Z"
                        acceptedAt: "2026-04-30T13:31:10.070Z"
                        activatedAt: "2026-04-30T13:31:12.698Z"
                    success: true
                empty:
                  summary: User has no in-flight calls
                  value:
                    calls: []
                    success: true
        '401':
          $ref: '#/components/responses/authorizationError'
tags:
  - name: Settings
  - name: Cloud
  - name: DNS
  - name: E2E
  - name: Import
  - name: Bulk User Import
  - name: Instances
  - name: Federation
  - name: Moderation
  - name: Device Management
  - name: Password policy
  - name: Video Conference
  - name: Media Calls
components:
  parameters:
    X-User-Id:
      name: X-User-Id
      in: header
      required: true
      schema:
        type: string
      example: CkCPNctrgCDfmWLqC
      description: The user ID.
    X-Auth-Token:
      name: X-Auth-Token
      in: header
      required: true
      schema:
        type: string
      example: 1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
      description: The authentication token.
    offset:
      name: offset
      in: query
      required: false
      schema:
        type: integer
      example: 50
      description: 'Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items. Refer to the [official documentation](https://developer.rocket.chat/apidocs/query-parameters#pagination) to learn more.'
    count:
      name: count
      in: query
      required: false
      schema:
        type: integer
      example: 50
      description: 'How many items to return. Refer to the [official documentation](https://developer.rocket.chat/apidocs/query-parameters#pagination) to learn more.'
    sort:
      name: sort
      in: query
      required: false
      schema: {}
      description: 'List of fields to order by, and in which direction. This is a JSON object, with properties listed in desired order, with values of 1 for ascending, or -1 for descending. For example, {"value": -1, "_id": 1}. Refer to the [official documentation](https://developer.rocket.chat/apidocs/query-parameters#pagination) to learn more.'
    query:
      name: query
      in: query
      required: false
      schema: {}
      description: 'This parameter allows you to use MongoDB query operators to search for specific data. For example, to query users with a name that contains the letter "g": `query={ "name": { "$regex": "g" } }`. Refer to the [official documentation](https://developer.rocket.chat/apidocs/query-parameters#query-and-fields) to learn more. '
    fields:
      name: fields
      in: query
      required: false
      schema: {}
      description: 'This parameter accepts a JSON object with properties that have a value of 1 or 0 to include or exclude them in the response. For example, to only retrieve the usernames of users: `fields={ "username": 1 }`. Refer to the [official documentation](https://developer.rocket.chat/apidocs/query-parameters#query-and-fields) to learn more.'
    x-2fa-code:
      name: x-2fa-code
      in: header
      schema:
        type: string
      description: >-
        The 2FA code. This parameter is required if 2FA is enabled in your workspace.
        See the <a href="https://developer.rocket.chat/apidocs/introduction-to-two-factor-authentication" target="_blank">Introduction to Two-Factor Authentication</a> document for details.
    X-2fa-method:
      name: x-2fa-method
      in: header
      schema:
        type: string
      description: 'Enter the method with which you get the 2FA code. It can be `email`, `totp`, or `password`. This parameter is required if 2FA is enabled in your workspace.'
  schemas: {}
  responses:
    authorizationError:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
              message:
                type: string
          examples:
            Authorization Error:
              value:
                status: error
                message: You must be logged in to do this.
    trueSuccess:
      description: OK
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
          examples:
            Success:
              value:
                success: true
    forbiddenError:
      description: Forbidden
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
              error:
                type: string
          examples:
            Permission Error:
              value:
                success: false
                error: 'User does not have the permissions required for this action [error-unauthorized]'