swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Invitation API
schemes:
- https
tags:
- name: Invitation
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/invitations/{invitationName}
  : get:
      tags:
      - Invitation
      summary: Microsoft Azure Get Invitation In A Share
      description: Get an invitation in a share
      operationId: microsoftAzureInvitationsGet
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/accountName'
      - name: shareName
        in: path
        description: The name of the share.
        required: true
        type: string
      - name: invitationName
        in: path
        description: The name of the invitation.
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Invitation'
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          schema:
            $ref: '#/definitions/DataShareError'
      x-ms-examples:
        Invitations_Get:
          $ref: ./examples/Invitations_Get.json
    put:
      tags:
      - Invitation
      summary: Microsoft Azure Sends A New Invitation To A Recipient To Access A Share
      description: 'Create an invitation '
      operationId: microsoftAzureInvitationsCreate
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/accountName'
      - name: shareName
        in: path
        description: The name of the share to send the invitation for.
        required: true
        type: string
      - name: invitationName
        in: path
        description: The name of the invitation.
        required: true
        type: string
      - name: invitation
        in: body
        description: Invitation details.
        required: true
        schema:
          $ref: '#/definitions/Invitation'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Invitation'
        '201':
          description: Success
          schema:
            $ref: '#/definitions/Invitation'
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          schema:
            $ref: '#/definitions/DataShareError'
      x-ms-examples:
        Invitations_Create:
          $ref: ./examples/Invitations_Create.json
    delete:
      tags:
      - Invitation
      summary: Microsoft Azure Delete Invitation In A Share
      description: Delete an invitation in a share
      operationId: microsoftAzureInvitationsDelete
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/accountName'
      - name: shareName
        in: path
        description: The name of the share.
        required: true
        type: string
      - name: invitationName
        in: path
        description: The name of the invitation.
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
        '204':
          description: Success
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          schema:
            $ref: '#/definitions/DataShareError'
      x-ms-examples:
        Invitations_Delete:
          $ref: ./examples/Invitations_Delete.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/invitations
  : get:
      tags:
      - Invitation
      summary: Microsoft Azure List All Invitations In A Share
      description: List invitations in a share
      operationId: microsoftAzureInvitationsListbyshare
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/accountName'
      - name: shareName
        in: path
        description: The name of the share.
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      - name: $skipToken
        in: query
        description: The continuation token
        required: false
        type: string
      - name: $filter
        in: query
        description: Filters the results using OData syntax.
        required: false
        type: string
      - name: $orderby
        in: query
        description: Sorts the results using OData syntax.
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/InvitationList'
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          schema:
            $ref: '#/definitions/DataShareError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Invitations_ListByShare:
          $ref: ./examples/Invitations_ListByShare.json
definitions:
  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
  InvitationList:
    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/Invitation'
  InvitationProperties:
    description: Invitation property bag.
    type: object
    properties:
      invitationId:
        description: unique invitation id
        type: string
        readOnly: true
      invitationStatus:
        description: The status of the invitation.
        enum:
        - Pending
        - Accepted
        - Rejected
        - Withdrawn
        type: string
        readOnly: true
        x-ms-enum:
          name: invitationStatus
          modelAsString: 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
      targetActiveDirectoryId:
        description: The target Azure AD Id. Can't be combined with email.
        type: string
      targetEmail:
        description: The email the invitation is directed to.
        type: string
      targetObjectId:
        description: "The target user or application Id that invitation is being sent to.\r\nMust be specified along TargetActiveDirectoryId. This enables sending\r\ninvitations to specific users or applications in an AD tenant."
        type: string
      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
  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
  DataShareError:
    description: The data share error model.
    required:
    - error
    type: object
    properties:
      error:
        $ref: '#/definitions/DataShareErrorInfo'
        description: The data share error body
  Invitation:
    description: A Invitation data transfer object.
    type: object
    allOf:
    - $ref: '#/definitions/ProxyDto'
    properties:
      properties:
        $ref: '#/definitions/InvitationProperties'
        description: Properties on the Invitation
        x-ms-client-flatten: true
parameters:
  api-version:
    name: api-version
    in: query
    description: The api version to use.
    required: true
    type: string
  resourceGroupName:
    name: resourceGroupName
    in: path
    description: The resource group name.
    required: true
    type: string
    x-ms-parameter-location: method
  accountName:
    name: accountName
    in: path
    description: The name of the share account.
    required: true
    type: string
    x-ms-parameter-location: method
  subscriptionId:
    name: subscriptionId
    in: path
    description: The subscription identifier
    required: true
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'