swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector BotHostSettings API
schemes:
- https
tags:
- name: BotHostSettings
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.BotService/hostSettings:
    get:
      tags:
      - BotHostSettings
      description: Get per subscription settings needed to host bot in compute resource such as Azure App Service
      operationId: microsoftAzureHostsettingsGet
      x-ms-examples:
        Get Bot Host Settings:
          $ref: ./examples/GetHostSettings.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/HostSettingsResponse'
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/Error'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Botservice Hostsettings
definitions:
  HostSettingsResponse:
    description: The response body returned for a request to Bot Service Management to check per subscription hostSettings
    type: object
    properties:
      OAuthUrl:
        description: For in-conversation bot user authentication
        type: string
      ToBotFromChannelOpenIdMetadataUrl:
        description: For verifying incoming tokens from the channels
        type: string
      ToBotFromChannelTokenIssuer:
        description: For verifying incoming tokens from the channels
        type: string
      ToBotFromEmulatorOpenIdMetadataUrl:
        description: For verifying incoming tokens from bot emulator
        type: string
      ToChannelFromBotLoginUrl:
        description: For getting access token to channels from bot host
        type: string
      ToChannelFromBotOAuthScope:
        description: For getting access token to channels from bot host
        type: string
      ValidateAuthority:
        description: Per cloud OAuth setting on whether authority is validated
        type: boolean
      BotOpenIdMetadata:
        description: Same as toBotFromChannelOpenIdMetadataUrl, used by SDK < v4.12
        type: string
  ErrorBody:
    properties:
      code:
        type: string
        description: error code
      message:
        type: string
        description: error message
    description: Bot Service error body.
    required:
    - code
    - message
  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'