swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Participants API
schemes:
- https
tags:
- name: Participants
paths:
  /chat/threads/{chatThreadId}/participants:
    get:
      tags:
      - Participants
      summary: Microsoft Azure Gets The Participants Of A Thread
      operationId: microsoftAzureChatthreadListchatparticipants
      produces:
      - application/json
      parameters:
      - in: path
        name: chatThreadId
        description: Thread id to get participants for.
        required: true
        type: string
      - in: query
        name: maxPageSize
        description: The maximum number of participants to be returned per page.
        type: integer
        format: int32
      - in: query
        name: skip
        description: Skips participants up to a specified position in response.
        type: integer
        format: int32
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Request successful. The action returns the participants of a thread.
          schema:
            $ref: '#/definitions/ChatParticipantsCollection'
        '401':
          description: Unauthorized.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '403':
          description: Forbidden.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '429':
          description: Too many requests.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '503':
          description: Service unavailable.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
      x-ms-examples:
        Get participants with pagination (max page size):
          $ref: ./examples/Participants_ListChatParticipantsWithPageSize.json
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
      description: Needs a more full description created.
  /chat/threads/{chatThreadId}/participants/:remove:
    post:
      tags:
      - Participants
      summary: Microsoft Azure Remove A Participant From A Thread
      operationId: microsoftAzureChatthreadRemovechatparticipant
      consumes:
      - application/json
      - application/merge-patch+json
      produces:
      - application/json
      parameters:
      - in: path
        name: chatThreadId
        description: Thread id to remove the participant from.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      - in: body
        name: participantCommunicationIdentifier
        description: Id of the thread participant to remove from the thread.
        required: true
        schema:
          $ref: '#/definitions/CommunicationIdentifierModel'
      responses:
        '204':
          description: Request successful.
        '401':
          description: Unauthorized.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '403':
          description: Forbidden.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '429':
          description: Too many requests.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '503':
          description: Service unavailable.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
      x-ms-examples:
        Remove participant:
          $ref: ./examples/Participants_RemoveChatParticipant.json
      description: Needs a more full description created.
  /chat/threads/{chatThreadId}/participants/:add:
    post:
      tags:
      - Participants
      summary: Microsoft Azure Adds Thread Participants To A Thread If Participants Already Exist, No Change Occurs
      operationId: microsoftAzureChatthreadAddchatparticipants
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: chatThreadId
        description: Id of the thread to add participants to.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      - in: body
        name: addChatParticipantsRequest
        description: Thread participants to be added to the thread.
        required: true
        schema:
          $ref: '#/definitions/AddChatParticipantsRequest'
      responses:
        '201':
          description: The participants were successfully added.
          schema:
            $ref: '#/definitions/AddChatParticipantsResult'
        '401':
          description: Unauthorized.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '403':
          description: Forbidden.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '429':
          description: Too many requests.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '503':
          description: Service unavailable.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
      x-ms-examples:
        Add participants:
          $ref: ./examples/Participants_AddChatParticipants.json
      description: Needs a more full description created.
  /rooms/{roomId}/participants:
    get:
      tags:
      - Participants
      summary: Microsoft Azure Get Participants In A Room
      operationId: microsoftAzureParticipantsList
      produces:
      - application/json
      parameters:
      - in: path
        name: roomId
        description: The id of the room to get participants from.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Request successful. The action returns the participants of the room.
          schema:
            $ref: '#/definitions/ParticipantsCollection'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CommunicationErrorResponse_2'
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              type: string
      x-ms-examples:
        Get participants:
          $ref: ./examples/Participants_List.json
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
      description: Needs a more full description created.
    patch:
      tags:
      - Participants
      summary: Microsoft Azure Update Participants In A Room
      operationId: microsoftAzureParticipantsUpdate
      consumes:
      - application/merge-patch+json
      produces:
      - application/json
      parameters:
      - in: path
        name: roomId
        description: The id of the room to update the participants in.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      - in: body
        name: updateParticipantsRequest
        description: An updated set of participants of the room.
        required: true
        schema:
          $ref: '#/definitions/UpdateParticipantsRequest'
      responses:
        '200':
          description: The participants were successfully updated.
          schema:
            $ref: '#/definitions/UpdateParticipantsResult'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CommunicationErrorResponse_2'
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              type: string
      x-ms-examples:
        Update participants:
          $ref: ./examples/Participants_Update.json
      description: Needs a more full description created.
definitions:
  ChatParticipant:
    description: A participant of the chat thread.
    required:
    - communicationIdentifier
    type: object
    properties:
      communicationIdentifier:
        $ref: '#/definitions/CommunicationIdentifierModel'
      displayName:
        description: Display name for the chat participant.
        type: string
        example: Bob
      shareHistoryTime:
        format: date-time
        description: 'Time from which the chat history is shared with the participant. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.'
        type: string
        example: '2020-10-30T10:50:50Z'
      metadata:
        description: Contextual metadata for the chat participant. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size.
        type: object
        additionalProperties:
          type: string
  CommunicationError:
    $ref: ../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationError
  CommunicationErrorResponse:
    $ref: ../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationErrorResponse
  Role:
    description: The role of a room participant. The default value is Attendee.
    enum:
    - Presenter
    - Attendee
    - Consumer
    type: string
    x-ms-enum:
      name: Role
      modelAsString: true
  CommunicationErrorResponse_2:
    $ref: ../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationErrorResponse
  ChatParticipantsCollection:
    description: Collection of participants belong to a particular thread.
    required:
    - value
    type: object
    properties:
      value:
        description: Chat participants.
        type: array
        items:
          $ref: '#/definitions/ChatParticipant'
      nextLink:
        description: If there are more chat participants that can be retrieved, the next link will be populated.
        type: string
        readOnly: true
  UpdateParticipantsRequest:
    description: Participants to be updated in the room.
    type: object
    properties:
      participants:
        description: Participants to be updated.
        type: object
        additionalProperties:
          $ref: '#/definitions/ParticipantProperties'
        example:
          rawId1:
            role: Presenter
          rawId2:
            role: Attendee
          rawId3: null
  CommunicationIdentifierModel:
    $ref: ../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationIdentifierModel
  RoomParticipant:
    description: A participant of the room.
    required:
    - rawId
    - role
    type: object
    properties:
      rawId:
        description: Raw ID representation of the communication identifier. Please refer to the following document for additional information on Raw ID. <br> https://learn.microsoft.com/azure/communication-services/concepts/identifiers?pivots=programming-language-rest#raw-id-representation
        type: string
      role:
        $ref: '#/definitions/Role'
  AddChatParticipantsRequest:
    description: Participants to be added to the thread.
    required:
    - participants
    type: object
    properties:
      participants:
        description: Participants to add to a chat thread.
        type: array
        items:
          $ref: '#/definitions/ChatParticipant'
  AddChatParticipantsResult:
    description: Result of the add chat participants operation.
    type: object
    properties:
      invalidParticipants:
        description: The participants that failed to be added to the chat thread.
        type: array
        items:
          $ref: '#/definitions/CommunicationError'
        readOnly: true
  ParticipantsCollection:
    description: A collection of participants in a room.
    required:
    - value
    type: object
    properties:
      value:
        description: A collection of participants.
        type: array
        items:
          $ref: '#/definitions/RoomParticipant'
      nextLink:
        description: If there are more participants that can be retrieved, the next link will be populated.
        type: string
  ParticipantProperties:
    required:
    - role
    type: object
    properties:
      role:
        $ref: '#/definitions/Role'
  UpdateParticipantsResult:
    description: Request response for updating participants.
    type: object
parameters:
  ApiVersionParameter:
    in: query
    name: api-version
    description: Version of API to invoke.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'