openapi: 3.1.0
info:
  title: Citrix ShareFile REST API v3 Accounts Shares API
  description: 'The ShareFile v3 REST API provides programmatic access to items,

    folders, files, users, groups, shares, and accounts in a customer

    subdomain. The API uses a subset of the OData specification with

    entity URIs of the form /sf/v3/{Entity}({id}). Authentication uses

    OAuth 2.0 with multiple supported grant types (authorization code,

    password, SAML assertion exchange), returning Bearer access tokens

    scoped to a customer subdomain.

    '
  version: 3.0.0
  contact:
    name: ShareFile API Documentation
    url: https://api.sharefile.com/
servers:
- url: https://{subdomain}.sf-api.com/sf/v3
  variables:
    subdomain:
      default: example
      description: ShareFile account subdomain
security:
- bearerAuth: []
tags:
- name: Shares
paths:
  /Shares:
    get:
      tags:
      - Shares
      summary: List shares
      operationId: getShares
      responses:
        '200':
          description: A page of shares
    post:
      tags:
      - Shares
      summary: Create a share
      operationId: createShare
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Share'
      responses:
        '201':
          description: Created share
  /Shares({id}):
    parameters:
    - in: path
      name: id
      required: true
      schema:
        type: string
    get:
      tags:
      - Shares
      summary: Get a share
      operationId: getShare
      responses:
        '200':
          description: A share
    delete:
      tags:
      - Shares
      summary: Delete a share
      operationId: deleteShare
      responses:
        '204':
          description: Deleted
components:
  schemas:
    Share:
      type: object
      properties:
        Id:
          type: string
        ShareType:
          type: string
          enum:
          - Send
          - Receive
        Title:
          type: string
        Items:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
        Recipients:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
              Email:
                type: string
                format: email
        HasSentMessage:
          type: boolean
        SentMessageTitle:
          type: string
        IsViewOnly:
          type: boolean
        RequireLogin:
          type: boolean
        RequireUserInfo:
          type: boolean
        Creator:
          type: object
          properties:
            Id:
              type: string
        CreationDate:
          type: string
          format: date-time
        ExpirationDate:
          type: string
          format: date-time
        MaxDownloads:
          type: integer
        TotalDownloads:
          type: integer
        IsConsumed:
          type: boolean
        IsRead:
          type: boolean
        url:
          type: string
          format: uri
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: OAuth2-Access-Token