openapi: 3.1.0
info:
  title: Citrix ShareFile REST API v3 Accounts Users 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: Users
paths:
  /Users:
    get:
      tags:
      - Users
      summary: List users in the account
      operationId: getUsers
      parameters:
      - in: query
        name: emailAddress
        schema:
          type: string
          format: email
      - in: query
        name: $skip
        schema:
          type: integer
      - in: query
        name: $top
        schema:
          type: integer
      responses:
        '200':
          description: A page of users
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/User'
    post:
      tags:
      - Users
      summary: Create a user
      operationId: createUser
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User'
      responses:
        '201':
          description: Created user
  /Users({id}):
    parameters:
    - in: path
      name: id
      required: true
      schema:
        type: string
    get:
      tags:
      - Users
      summary: Get a user
      operationId: getUser
      responses:
        '200':
          description: A user
    patch:
      tags:
      - Users
      summary: Update a user
      operationId: updateUser
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User'
      responses:
        '200':
          description: Updated user
    delete:
      tags:
      - Users
      summary: Delete a user
      operationId: deleteUser
      responses:
        '204':
          description: Deleted
components:
  schemas:
    User:
      type: object
      properties:
        Id:
          type: string
        Email:
          type: string
          format: email
        FirstName:
          type: string
        LastName:
          type: string
        Company:
          type: string
        FullName:
          type: string
        Roles:
          type: array
          items:
            type: string
        IsAdministrator:
          type: boolean
        IsEmployee:
          type: boolean
        IsConfirmed:
          type: boolean
        IsDisabled:
          type: boolean
        DefaultZone:
          type: object
          properties:
            Id:
              type: string
        url:
          type: string
          format: uri
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: OAuth2-Access-Token