swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ListServiceProviders API
schemes:
- https
tags:
- name: ListServiceProviders
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.BotService/listAuthServiceProviders:
    post:
      tags:
      - ListServiceProviders
      description: Lists the available Service Providers for creating Connection Settings
      operationId: microsoftAzureBotconnectionListserviceproviders
      x-ms-examples:
        List Auth Service Providers:
          $ref: ./examples/ListServiceProviders.json
      parameters:
      - $ref: '#/parameters/apiVersionParameter'
      - $ref: '#/parameters/subscriptionIdParameter'
      responses:
        '200':
          description: If resource is retrieved successfully, the service should return 200 (OK).
          schema:
            $ref: '#/definitions/ServiceProviderResponseList'
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/Error'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Botservice Listauthserviceproviders
definitions:
  ServiceProvider:
    type: object
    description: Service Provider Definition
    properties:
      properties:
        $ref: '#/definitions/ServiceProviderProperties'
        description: The Properties of a Service Provider Object
  ServiceProviderParameter:
    properties:
      name:
        type: string
        description: Name of the Service Provider
        readOnly: true
      type:
        type: string
        description: Type of the Service Provider
        readOnly: true
      displayName:
        type: string
        description: Display Name of the Service Provider
        readOnly: true
      description:
        type: string
        description: Description of the Service Provider
        readOnly: true
      helpUrl:
        type: string
        description: Help Url for the  Service Provider
        readOnly: true
      default:
        type: string
        description: Default Name for the Service Provider
        readOnly: true
      metadata:
        type: object
        description: Meta data for the Service Provider
        readOnly: true
        properties:
          constraints:
            description: the constraints of the bot meta data.
            type: object
            properties:
              required:
                description: Whether required the constraints of the bot meta data.
                type: boolean
    description: Extra Parameters specific to each Service Provider
  ServiceProviderProperties:
    properties:
      id:
        type: string
        description: Id for Service Provider
        readOnly: true
      displayName:
        type: string
        description: Display Name of the Service Provider
        readOnly: true
      serviceProviderName:
        type: string
        description: Name of the Service Provider
        readOnly: true
      devPortalUrl:
        type: string
        description: URL of Dev Portal
        readOnly: true
      iconUrl:
        type: string
        description: The URL of icon
        default: ''
      parameters:
        description: The list of parameters for the Service Provider
        type: array
        items:
          $ref: '#/definitions/ServiceProviderParameter'
    description: The Object used to describe a Service Provider supported by Bot Service
  ErrorBody:
    properties:
      code:
        type: string
        description: error code
      message:
        type: string
        description: error message
    description: Bot Service error body.
    required:
    - code
    - message
  ServiceProviderResponseList:
    properties:
      nextLink:
        description: The link used to get the next page of bot service providers.
        type: string
      value:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/ServiceProvider'
        description: Gets the list of bot service providers and their properties.
    description: The list of bot service providers response.
  Error:
    properties:
      error:
        $ref: '#/definitions/ErrorBody'
        description: The error body.
    description: Bot Service error object.
parameters:
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: Azure Subscription ID.
    required: true
    type: string
  apiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Version of the API to be used with the client request.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'