swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Connections API
schemes:
- https
tags:
- name: Connections
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connections:
    get:
      tags:
      - Connections
      summary: Microsoft Azure Get All Connections
      operationId: microsoftAzureConnectionsList
      description: Gets a list of connections
      x-ms-examples:
        List all connections:
          $ref: ./examples/connectionsList.json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/pageSizeParameter'
      - $ref: '#/parameters/filterParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: A list of API connection
          schema:
            $ref: '#/definitions/ApiConnectionDefinitionCollection'
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connections/{connectionName}:
    get:
      tags:
      - Connections
      summary: Microsoft Azure Get A Connection
      operationId: microsoftAzureConnectionsGet
      description: Get a specific connection
      x-ms-examples:
        Get a connection:
          $ref: ./examples/connectionsGet.json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/connectionNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: An API connection
          schema:
            $ref: '#/definitions/ApiConnectionDefinition'
    put:
      tags:
      - Connections
      summary: Microsoft Azure Replace An Existing Connection
      operationId: microsoftAzureConnectionsCreateorupdate
      description: Creates or updates a connection
      x-ms-examples:
        Replace a connection:
          $ref: ./examples/connectionsCreateOrUpdate.json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/connectionNameParameter'
      - $ref: '#/parameters/apiConnectionParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: New API connection created
          schema:
            $ref: '#/definitions/ApiConnectionDefinition'
        '201':
          description: Already existing API connection updated
          schema:
            $ref: '#/definitions/ApiConnectionDefinition'
    patch:
      tags:
      - Connections
      summary: Microsoft Azure Update An Existing Connection
      operationId: microsoftAzureConnectionsUpdate
      description: Updates a connection's tags
      x-ms-examples:
        Update a connection's tags:
          $ref: ./examples/connectionsUpdate.json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/connectionNameParameter'
      - $ref: '#/parameters/apiConnectionParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: API connection updated
          schema:
            $ref: '#/definitions/ApiConnectionDefinition'
    delete:
      tags:
      - Connections
      summary: Microsoft Azure Delete An Existing Connection
      operationId: microsoftAzureConnectionsDelete
      description: Deletes a connection
      x-ms-examples:
        Delete a connection:
          $ref: ./examples/connectionsDelete.json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/connectionNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully deleted the connection
        '204':
          description: No connection to delete
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connections/{connectionName}/listConsentLinks
  : post:
      tags:
      - Connections
      summary: Microsoft Azure Lists Consent Links For A Connection
      operationId: microsoftAzureConnectionsListconsentlinks
      description: Lists the consent links of a connection
      x-ms-examples:
        List consent links:
          $ref: ./examples/connectionsListConsentLinks.json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/connectionNameParameter'
      - $ref: '#/parameters/listConsentLinkParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: A list of the consent links
          schema:
            $ref: '#/definitions/ConsentLinkCollection'
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connections/{connectionName}/confirmConsentCode
  : post:
      tags:
      - Connections
      summary: Microsoft Azure Confirms The Consent Code For A Connection
      operationId: microsoftAzureConnectionsConfirmconsentcode
      description: Confirms consent code of a connection
      x-ms-examples:
        Confirm consent code:
          $ref: ./examples/connectionsConfirmConsentCode.json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/connectionNameParameter'
      - $ref: '#/parameters/confirmConsentCodeParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Confirmation of the consent code
          schema:
            $ref: '#/definitions/ConfirmConsentCodeDefinition'
definitions:
  ConfirmConsentCodeDefinition:
    description: Confirm consent code request
    type: object
    properties:
      tenantId:
        description: Tenant Id
        type: string
      objectId:
        description: AAD object ID. This is userId
        type: string
      code:
        description: Code that was returned during consent flow
        type: string
  ConsentLinkParameterDefinition:
    description: Consent link definition
    type: object
    properties:
      parameterName:
        description: Name of the parameter in the connection provider's OAuth settings
        type: string
      redirectUrl:
        description: Name of the parameter in the connection provider's OAuth settings
        type: string
      objectId:
        description: AAD OID (user or group) if the principal type is ActiveDirectory. MSA PUID if the principal type is MicrosoftAccount
        type: string
      tenantId:
        description: The tenant id
        type: string
  ApiConnectionDefinitionCollection:
    description: A list of API connection definitions
    type: object
    properties:
      value:
        description: Collection of API connections
        type: array
        items:
          $ref: '#/definitions/ApiConnectionDefinition'
  ListConsentLinksDefinition:
    description: Request for a list of consent links
    type: object
    properties:
      parameters:
        description: Collection of resources
        type: array
        items:
          $ref: '#/definitions/ConsentLinkParameterDefinition'
  TagsDictionary:
    type: object
    description: Resource tags
    additionalProperties:
      type: string
    example:
      SampleTagName: SampleTagValue
  ResourceDefinition:
    description: A resource
    type: object
    additionalProperties: false
    properties:
      id:
        description: Resource id
        type: string
        readOnly: true
      name:
        description: Resource name
        type: string
        readOnly: true
      type:
        description: Resource type
        type: string
        readOnly: true
      location:
        description: Resource location
        type: string
      etag:
        description: Resource ETag
        type: string
      tags:
        $ref: '#/definitions/TagsDictionary'
    x-ms-azure-resource: true
  ConnectionStatusDefinition:
    description: Connection status
    type: object
    properties:
      status:
        description: The gateway status
        type: string
      target:
        description: Target of the error
        type: string
      error:
        $ref: '#/definitions/ConnectionError'
  ConnectionError:
    description: Connection error
    type: object
    allOf:
    - $ref: '#/definitions/ResourceDefinition'
    properties:
      properties:
        properties:
          code:
            description: Code of the status
            type: string
          message:
            description: Description of the status
            type: string
        x-ms-client-flatten: true
  ApiConnectionDefinition:
    description: API connection
    type: object
    additionalProperties: false
    properties:
      properties:
        properties:
          displayName:
            description: Display name
            type: string
          statuses:
            description: Status of the connection
            type: array
            items:
              $ref: '#/definitions/ConnectionStatusDefinition'
          parameterValues:
            description: Dictionary of parameter values
            type: object
            additionalProperties:
              type: string
          customParameterValues:
            description: Dictionary of custom parameter values
            type: object
            additionalProperties:
              type: string
          nonSecretParameterValues:
            description: Dictionary of nonsecret parameter values
            type: object
            additionalProperties:
              type: string
          createdTime:
            format: date-time
            description: Timestamp of the connection creation
            type: string
          changedTime:
            format: date-time
            description: Timestamp of last connection change
            type: string
          api:
            $ref: '#/definitions/ApiReference'
          testLinks:
            description: Links to test the API connection
            type: array
            items:
              $ref: '#/definitions/ApiConnectionTestLink'
    allOf:
    - $ref: '#/definitions/ResourceDefinition'
  ResourceReference:
    type: object
    x-abstract: true
    additionalProperties: false
    properties:
      id:
        description: Resource reference id
        type: string
      type:
        description: Resource reference type
        type: string
  ApiReference:
    type: object
    x-abstract: true
    additionalProperties: false
    properties:
      swagger:
        type: object
        description: The JSON representation of the swagger
      brandColor:
        type: string
        description: Brand color
      description:
        type: string
        description: The custom API description
      displayName:
        type: string
        description: The display name
      iconUri:
        type: string
        description: The icon URI
      name:
        type: string
        description: The name of the API
    allOf:
    - $ref: '#/definitions/ResourceReference'
  ApiConnectionTestLink:
    description: API connection properties
    type: object
    additionalProperties: false
    properties:
      requestUri:
        description: Test link request URI
        type: string
      method:
        description: HTTP Method
        type: string
  ConsentLinkDefinition:
    description: A consent link
    type: object
    properties:
      link:
        description: URI for the consent link
        type: string
      firstPartyLoginUri:
        description: URI for first party login
        type: string
      displayName:
        description: Display name of the parameter in the connection provider's OAuth settings
        type: string
      status:
        description: Status of the link
        enum:
        - Unauthenticated
        - Authenticated
        - Error
        type: string
        x-ms-enum:
          name: LinkState
          modelAsString: true
  ConsentLinkCollection:
    description: Collection of consent links
    type: object
    properties:
      value:
        description: Collection of resources
        type: array
        items:
          $ref: '#/definitions/ConsentLinkDefinition'
parameters:
  confirmConsentCodeParameter:
    name: confirmConsentCode
    description: The consent code confirmation
    in: body
    required: true
    schema:
      $ref: '#/definitions/ConfirmConsentCodeDefinition'
    x-ms-parameter-location: method
  resourceGroupNameParameter:
    name: resourceGroupName
    description: The resource group
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
  listConsentLinkParameter:
    name: listConsentLink
    description: The consent links
    in: body
    required: true
    schema:
      $ref: '#/definitions/ListConsentLinksDefinition'
    x-ms-parameter-location: method
  filterParameter:
    name: $filter
    description: The filter to apply on the operation
    in: query
    required: false
    type: string
    x-ms-parameter-location: method
  apiVersionParameter:
    name: api-version
    in: query
    description: API Version
    required: true
    type: string
    x-ms-parameter-location: method
  pageSizeParameter:
    name: $top
    description: The number of items to be included in the result
    in: query
    required: false
    type: integer
    format: int32
    x-ms-parameter-location: method
  connectionNameParameter:
    type: string
    name: connectionName
    description: Connection name
    in: path
    required: true
    x-ms-parameter-location: method
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: Subscription Id
    required: true
    type: string
    x-ms-parameter-location: method
  apiConnectionParameter:
    name: connection
    description: The connection
    in: body
    required: true
    schema:
      $ref: '#/definitions/ApiConnectionDefinition'
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'