Microsoft 365 Chats.teams Tab API

openapi: 3.2.0
info:
  title: Chats.teams Tab API
  version: v1.0
servers:
- url: https://graph.microsoft.com/v1.0/
  description: Core
security:
- azureaadv2: []
tags:
- name: chats.teamsTab
paths:
  /chats/{chat-id}/tabs:
    get:
      tags:
      - chats.teamsTab
      summary: List tabs in chat
      description: Retrieve the list of tabs in the specified chat.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/chat-list-tabs?view=graph-rest-1.0
      operationId: chat_ListTab
      parameters:
      - name: chat-id
        in: path
        description: The unique identifier of chat
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: chat
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/count'
      - name: $orderby
        in: query
        description: Order items by property values
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          $ref: '#/components/responses/microsoft.graph.teamsTabCollectionResponse'
        default:
          $ref: '#/components/responses/error'
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
      x-ms-docs-operation-type: operation
    post:
      tags:
      - chats.teamsTab
      summary: Add tab to chat
      description: 'Add (pin) a tab to the specified chat.

        The corresponding app must already be installed in the chat.'
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/chat-post-tabs?view=graph-rest-1.0
      operationId: chat_CreateTab
      parameters:
      - name: chat-id
        in: path
        description: The unique identifier of chat
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: chat
      requestBody:
        description: New navigation property
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.teamsTab'
        required: true
      responses:
        2XX:
          description: Created navigation property.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.teamsTab'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /chats/{chat-id}/tabs/{teamsTab-id}:
    get:
      tags:
      - chats.teamsTab
      summary: Get tab in chat
      description: Retrieve the properties and relationships of the specified tab in a chat.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/chat-get-tabs?view=graph-rest-1.0
      operationId: chat_GetTab
      parameters:
      - name: chat-id
        in: path
        description: The unique identifier of chat
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: chat
      - name: teamsTab-id
        in: path
        description: The unique identifier of teamsTab
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: teamsTab
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          description: Retrieved navigation property
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.teamsTab'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
      - chats.teamsTab
      summary: Update tab in chat
      description: 'Update the properties of the specified tab in a chat.

        This can be used to configure the content of the tab.'
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/chat-patch-tabs?view=graph-rest-1.0
      operationId: chat_UpdateTab
      parameters:
      - name: chat-id
        in: path
        description: The unique identifier of chat
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: chat
      - name: teamsTab-id
        in: path
        description: The unique identifier of teamsTab
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: teamsTab
      requestBody:
        description: New navigation property values
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.teamsTab'
        required: true
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.teamsTab'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
      - chats.teamsTab
      summary: Delete tab from chat
      description: Remove (unpin) a tab from the specified chat.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/chat-delete-tabs?view=graph-rest-1.0
      operationId: chat_DeleteTab
      parameters:
      - name: chat-id
        in: path
        description: The unique identifier of chat
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: chat
      - name: teamsTab-id
        in: path
        description: The unique identifier of teamsTab
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: teamsTab
      - name: If-Match
        in: header
        description: ETag
        style: simple
        schema:
          type: string
      responses:
        2XX:
          description: Success
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /chats/{chat-id}/tabs/{teamsTab-id}/teamsApp:
    get:
      tags:
      - chats.teamsTab
      summary: Get teamsApp from chats
      description: The application that is linked to the tab. This can't be changed after tab creation.
      operationId: chat.tab_GetTeamsApp
      parameters:
      - name: chat-id
        in: path
        description: The unique identifier of chat
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: chat
      - name: teamsTab-id
        in: path
        description: The unique identifier of teamsTab
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: teamsTab
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          description: Retrieved navigation property
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.teamsApp'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /chats/{chat-id}/tabs/$count:
    get:
      tags:
      - chats.teamsTab
      summary: Get the number of the resource
      operationId: chat.tab_GetCount
      parameters:
      - name: chat-id
        in: path
        description: The unique identifier of chat
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: chat
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      responses:
        2XX:
          $ref: '#/components/responses/ODataCountResponse'
        default:
          $ref: '#/components/responses/error'
components:
  schemas:
    microsoft.graph.identitySet:
      title: identitySet
      type: object
      properties:
        application:
          $ref: '#/components/schemas/microsoft.graph.identity'
        device:
          $ref: '#/components/schemas/microsoft.graph.identity'
        user:
          $ref: '#/components/schemas/microsoft.graph.identity'
      additionalProperties:
        type: object
    microsoft.graph.identity:
      title: identity
      type: object
      properties:
        displayName:
          type:
          - string
          - 'null'
          description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don't show up as changed when using delta.
        id:
          type:
          - string
          - 'null'
          description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
      additionalProperties:
        type: object
    microsoft.graph.teamsTabConfiguration:
      title: teamsTabConfiguration
      type: object
      properties:
        contentUrl:
          type:
          - string
          - 'null'
          description: Url used for rendering tab contents in Teams. Required.
        entityId:
          type:
          - string
          - 'null'
          description: Identifier for the entity hosted by the tab provider.
        removeUrl:
          type:
          - string
          - 'null'
          description: Url called by Teams client when a Tab is removed using the Teams Client.
        websiteUrl:
          type:
          - string
          - 'null'
          description: Url for showing tab contents outside of Teams.
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.MainError:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
          x-ms-primary-error-message: true
        target:
          type:
          - string
          - 'null'
        details:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails'
        innerError:
          $ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError'
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.ODataError:
      required:
      - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError'
      additionalProperties:
        type: object
    microsoft.graph.teamsAppPermissionSet:
      title: teamsAppPermissionSet
      type: object
      properties:
        resourceSpecificPermissions:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.teamsAppResourceSpecificPermission'
          description: A collection of resource-specific permissions.
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.ErrorDetails:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        target:
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
    microsoft.graph.teamsAppResourceSpecificPermission:
      title: teamsAppResourceSpecificPermission
      type: object
      properties:
        permissionType:
          $ref: '#/components/schemas/microsoft.graph.teamsAppResourceSpecificPermissionType'
        permissionValue:
          type:
          - string
          - 'null'
          description: The name of the resource-specific permission.
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.InnerError:
      type: object
      additionalProperties:
        type: object
      description: The structure of this object is service-specific
    microsoft.graph.teamsApp:
      allOf:
      - $ref: '#/components/schemas/microsoft.graph.entity'
      - title: teamsApp
        type: object
        properties:
          displayName:
            type:
            - string
            - 'null'
            description: The name of the catalog app provided by the app developer in the Microsoft Teams zip app package.
          distributionMethod:
            $ref: '#/components/schemas/microsoft.graph.teamsAppDistributionMethod'
          externalId:
            type:
            - string
            - 'null'
            description: The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.
          appDefinitions:
            type: array
            items:
              $ref: '#/components/schemas/microsoft.graph.teamsAppDefinition'
            description: The details for each version of the app.
            x-ms-navigationProperty: true
        additionalProperties:
          type: object
    microsoft.graph.teamsAppResourceSpecificPermissionType:
      title: teamsAppResourceSpecificPermissionType
      enum:
      - delegated
      - application
      - unknownFutureValue
      type: string
    microsoft.graph.teamsTab:
      allOf:
      - $ref: '#/components/schemas/microsoft.graph.entity'
      - title: teamsTab
        type: object
        properties:
          configuration:
            $ref: '#/components/schemas/microsoft.graph.teamsTabConfiguration'
          displayName:
            type:
            - string
            - 'null'
            description: Name of the tab.
          webUrl:
            type:
            - string
            - 'null'
            description: Deep link URL of the tab instance. Read-only.
          teamsApp:
            $ref: '#/components/schemas/microsoft.graph.teamsApp'
        additionalProperties:
          type: object
    microsoft.graph.teamworkBot:
      allOf:
      - $ref: '#/components/schemas/microsoft.graph.entity'
      - title: teamworkBot
        type: object
        additionalProperties:
          type: object
    microsoft.graph.teamsAppDefinition:
      allOf:
      - $ref: '#/components/schemas/microsoft.graph.entity'
      - title: teamsAppDefinition
        type: object
        properties:
          authorization:
            $ref: '#/components/schemas/microsoft.graph.teamsAppAuthorization'
          createdBy:
            $ref: '#/components/schemas/microsoft.graph.identitySet'
          description:
            type:
            - string
            - 'null'
            description: Verbose description of the application.
          displayName:
            type:
            - string
            - 'null'
            description: The name of the app provided by the app developer.
          lastModifiedDateTime:
            pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
            type:
            - string
            - 'null'
            format: date-time
          publishingState:
            $ref: '#/components/schemas/microsoft.graph.teamsAppPublishingState'
          shortDescription:
            type:
            - string
            - 'null'
            description: Short description of the application.
          teamsAppId:
            type:
            - string
            - 'null'
            description: The ID from the Teams app manifest.
          version:
            type:
            - string
            - 'null'
            description: The version number of the application.
          bot:
            $ref: '#/components/schemas/microsoft.graph.teamworkBot'
        additionalProperties:
          type: object
    microsoft.graph.teamsAppPublishingState:
      title: teamsAppPublishingState
      enum:
      - submitted
      - rejected
      - published
      - unknownFutureValue
      type: string
    microsoft.graph.teamsAppDistributionMethod:
      title: teamsAppDistributionMethod
      enum:
      - store
      - organization
      - sideloaded
      - unknownFutureValue
      type: string
    ODataCountResponse:
      type: integer
      format: int32
    microsoft.graph.entity:
      title: entity
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for an entity. Read-only.
      additionalProperties:
        type: object
    microsoft.graph.teamsAppAuthorization:
      title: teamsAppAuthorization
      type: object
      properties:
        clientAppId:
          type:
          - string
          - 'null'
          description: The registration ID of the Microsoft Entra app ID associated with the teamsApp.
        requiredPermissionSet:
          $ref: '#/components/schemas/microsoft.graph.teamsAppPermissionSet'
      additionalProperties:
        type: object
    microsoft.graph.teamsTabCollectionResponse:
      title: Collection of teamsTab
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.teamsTab'
        '@odata.nextLink':
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
  responses:
    microsoft.graph.teamsTabCollectionResponse:
      description: Retrieved collection
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.teamsTabCollectionResponse'
    ODataCountResponse:
      description: The count of the resource
      content:
        text/plain:
          schema:
            $ref: '#/components/schemas/ODataCountResponse'
    error:
      description: error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.ODataErrors.ODataError'
  parameters:
    top:
      name: $top
      in: query
      description: Show only the first n items
      style: form
      explode: false
      schema:
        minimum: 0
        type: integer
      example: 50
    search:
      name: $search
      in: query
      description: Search items by search phrases
      style: form
      explode: false
      schema:
        type: string
    skip:
      name: $skip
      in: query
      description: Skip the first n items
      style: form
      explode: false
      schema:
        minimum: 0
        type: integer
    filter:
      name: $filter
      in: query
      description: Filter items by property values
      style: form
      explode: false
      schema:
        type: string
    count:
      name: $count
      in: query
      description: Include count of items
      style: form
      explode: false
      schema:
        type: boolean
  securitySchemes:
    azureaadv2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
          tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
          scopes: {}