swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ConsumerInvitation API
schemes:
- https
tags:
- name: ConsumerInvitation
paths:
  /providers/Microsoft.DataShare/listInvitations:
    get:
      tags:
      - ConsumerInvitation
      summary: Microsoft Azure List The Invitations
      description: Lists invitations
      operationId: microsoftAzureConsumerinvitationsListinvitations
      parameters:
      - $ref: '#/parameters/api-version'
      - name: $skipToken
        in: query
        description: The continuation token
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ConsumerInvitationList'
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          schema:
            $ref: '#/definitions/DataShareError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        ConsumerInvitations_ListInvitations:
          $ref: ./examples/ConsumerInvitations_ListInvitations.json
  /providers/Microsoft.DataShare/locations/{location}/consumerInvitations/{invitationId}:
    get:
      tags:
      - ConsumerInvitation
      summary: Microsoft Azure Gets The Invitation Identified By Invitationid
      description: Get an invitation
      operationId: microsoftAzureConsumerinvitationsGet
      parameters:
      - name: location
        in: path
        description: Location of the invitation
        required: true
        type: string
      - name: invitationId
        in: path
        description: An invitation id
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ConsumerInvitation'
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          schema:
            $ref: '#/definitions/DataShareError'
      x-ms-examples:
        ConsumerInvitations_Get:
          $ref: ./examples/ConsumerInvitations_Get.json
  /providers/Microsoft.DataShare/locations/{location}/rejectInvitation:
    post:
      tags:
      - ConsumerInvitation
      summary: Microsoft Azure Rejects The Invitation Identified By Invitationid
      description: Reject an invitation
      operationId: microsoftAzureConsumerinvitationsRejectinvitation
      parameters:
      - name: location
        in: path
        description: Location of the invitation
        required: true
        type: string
      - name: invitation
        in: body
        description: An invitation payload
        required: true
        schema:
          $ref: '#/definitions/ConsumerInvitation'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ConsumerInvitation'
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          schema:
            $ref: '#/definitions/DataShareError'
      x-ms-examples:
        ConsumerInvitations_RejectInvitation:
          $ref: ./examples/ConsumerInvitations_RejectInvitation.json
definitions:
  ConsumerInvitationProperties:
    description: Properties of consumer invitation
    required:
    - invitationId
    type: object
    properties:
      dataSetCount:
        format: int32
        description: Number of data sets in a share
        type: integer
        readOnly: true
      description:
        description: Description shared when the invitation was created
        type: string
        readOnly: true
      invitationId:
        description: Unique id of the invitation.
        type: string
      invitationStatus:
        description: The status of the invitation.
        enum:
        - Pending
        - Accepted
        - Rejected
        - Withdrawn
        type: string
        readOnly: true
        x-ms-enum:
          name: invitationStatus
          modelAsString: true
      location:
        description: invitation location
        type: string
        readOnly: true
      providerEmail:
        description: Email of the provider who created the resource
        type: string
        readOnly: true
      providerName:
        description: Name of the provider who created the resource
        type: string
        readOnly: true
      providerTenantName:
        description: Tenant name of the provider who created the resource
        type: string
        readOnly: true
      respondedAt:
        format: date-time
        description: The time the recipient responded to the invitation.
        type: string
        readOnly: true
      sentAt:
        format: date-time
        description: Gets the time at which the invitation was sent.
        type: string
        readOnly: true
      shareName:
        description: Gets the source share Name.
        type: string
        readOnly: true
      termsOfUse:
        description: Terms of use shared when the invitation was created
        type: string
        readOnly: true
      userEmail:
        description: Email of the user who created the resource
        type: string
        readOnly: true
      userName:
        description: Name of the user who created the resource
        type: string
        readOnly: true
  ProxyDto:
    description: Base data transfer object implementation for proxy resources.
    type: object
    properties:
      id:
        description: The resource id of the azure resource
        type: string
        readOnly: true
      name:
        description: Name of the azure resource
        type: string
        readOnly: true
      type:
        description: Type of the azure resource
        type: string
        readOnly: true
    x-ms-azure-resource: true
  DataShareErrorInfo:
    description: The data share error body model.
    required:
    - code
    - message
    type: object
    properties:
      code:
        description: Code of the error
        type: string
      details:
        description: Nested details of the error model
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/DataShareErrorInfo'
      message:
        description: Message of the error
        type: string
      target:
        description: Target of the error
        type: string
  ConsumerInvitation:
    description: A consumer Invitation data transfer object.
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/ProxyDto'
    properties:
      properties:
        $ref: '#/definitions/ConsumerInvitationProperties'
        description: Properties on the account
        x-ms-client-flatten: true
  ConsumerInvitationList:
    description: List response for get InvitationList
    required:
    - value
    type: object
    properties:
      nextLink:
        description: The Url of next result page.
        type: string
      value:
        description: Collection of items of type DataTransferObjects.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/ConsumerInvitation'
  DataShareError:
    description: The data share error model.
    required:
    - error
    type: object
    properties:
      error:
        $ref: '#/definitions/DataShareErrorInfo'
        description: The data share error body
parameters:
  api-version:
    name: api-version
    in: query
    description: The api version to use.
    required: true
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'