Salesforce Shares API

openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Shares API
  description: 'Salesforce Bulk API 2.0 is a simplified, REST-based interface for bulk data operations that improves on the original Bulk API. It uses a straightforward job model and supports CSV format for ingest and query jobs, enabling processing of millions of records asynchronously.

    '
  version: v63.0
  contact:
    name: Salesforce Developers
    url: https://developer.salesforce.com/
  license:
    name: Salesforce Developer Terms
    url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v{version}/jobs
  description: Salesforce Bulk API 2.0 jobs endpoint
  variables:
    instance:
      default: yourInstance
      description: 'The Salesforce instance identifier (e.g., na1, eu3, or a My Domain subdomain like mycompany).

        '
    version:
      default: '63.0'
      description: 'The Salesforce API version number (e.g., 63.0). Use the latest supported version for new integrations.

        '
security:
- BearerAuth: []
tags:
- name: Shares
paths:
  /data/v64.0/connect/files/{FILE_ID}/file-shares:
    parameters: []
    get:
      tags:
      - Shares
      summary: Salesforce File Shares
      description: 'Returns information about the objects with which the specified file has been shared. Objects can be users, groups, or records.


        https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_files_shares.htm'
      operationId: FileShares
      parameters:
      - name: FILE_ID
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: '500123'
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 20 Nov 2023 16:37:07 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/SuccessfulFileShares'
                - examples:
                  - currentPageUrl: /services/data/v58.0/connect/files/069.../file-shares
                    linkShare: null
                    nextPageUrl: null
                    previousPageUrl: null
                    shares:
                    - entity:
                        additionalLabel: null
                        communityNickname: User1696423780773910041
                        companyName: Salesforce
                        displayName: Name
                        firstName: firstName
                        id: 005...
                        isActive: true
                        isInThisCommunity: true
                        lastName: Name
                        motif:
                          color: 1B96FF
                          largeIconUrl: /img/icon/profile64.png
                          mediumIconUrl: /img/icon/profile32.png
                          smallIconUrl: /img/icon/profile16.png
                          svgIconUrl: null
                        mySubscription: null
                        name: Name
                        outOfOffice:
                          message: ''
                        photo:
                          fullEmailPhotoUrl: https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1
                          largePhotoUrl: https://<my_domain>/profilephoto/7292o000000oAgZ/F
                          mediumPhotoUrl: https://<my_domain>/profilephoto/7292o000000oAgZ/M
                          photoVersionId: 729...
                          smallPhotoUrl: https://<my_domain>/profilephoto/7292o000000oAgZ/T
                          standardEmailPhotoUrl: https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1
                          url: /services/data/v58.0/connect/user-profiles/005.../photo
                        reputation: null
                        title: null
                        type: User
                        url: /services/data/v58.0/chatter/users/005...
                        userType: Internal
                      sharingType: I
                contentMediaType: application/json;charset=UTF-8
              example:
                currentPageUrl: /services/data/v58.0/connect/files/069.../file-shares
                linkShare: null
                nextPageUrl: null
                previousPageUrl: null
                shares:
                - entity:
                    additionalLabel: null
                    communityNickname: User1696423780773910041
                    companyName: Salesforce
                    displayName: Name
                    firstName: firstName
                    id: 005...
                    isActive: true
                    isInThisCommunity: true
                    lastName: Name
                    motif:
                      color: 1B96FF
                      largeIconUrl: /img/icon/profile64.png
                      mediumIconUrl: /img/icon/profile32.png
                      smallIconUrl: /img/icon/profile16.png
                      svgIconUrl: null
                    mySubscription: null
                    name: Name
                    outOfOffice:
                      message: ''
                    photo:
                      fullEmailPhotoUrl: https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1
                      largePhotoUrl: https://<my_domain>/profilephoto/7292o000000oAgZ/F
                      mediumPhotoUrl: https://<my_domain>/profilephoto/7292o000000oAgZ/M
                      photoVersionId: 729...
                      smallPhotoUrl: https://<my_domain>/profilephoto/7292o000000oAgZ/T
                      standardEmailPhotoUrl: https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1
                      url: /services/data/v58.0/connect/user-profiles/005.../photo
                    reputation: null
                    title: null
                    type: User
                    url: /services/data/v58.0/chatter/users/005...
                    userType: Internal
                  sharingType: I
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/connect/files/{FILE_ID}/file-shares/link:
    parameters: []
    put:
      tags:
      - Shares
      summary: Salesforce Files Shares Link
      description: 'A description of a file shared as a link. Create, access, and delete a file’s share link.


        https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_files_shares_link.htm'
      operationId: FilesSharesLink
      parameters:
      - name: FILE_ID
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: '500123'
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 20 Nov 2023 16:38:31 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/SuccessfulFilesSharesLink'
                - examples:
                  - expirationDate: null
                    fileViewUrl: https://<my_domain>/sfc/p/2o000000i6mB/a/2o00000022S3/y2zsu9pHtEVIa49w6ElaXdjXz_GxBSzRVwe645_Z.dw
                    isPasswordRequired: false
                    password: null
                    sharingType: V
                contentMediaType: application/json;charset=UTF-8
              example:
                expirationDate: null
                fileViewUrl: https://<my_domain>/sfc/p/2o000000i6mB/a/2o00000022S3/y2zsu9pHtEVIa49w6ElaXdjXz_GxBSzRVwe645_Z.dw
                isPasswordRequired: false
                password: null
                sharingType: V
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Share:
      title: Share
      required:
      - entity
      - sharingType
      type: object
      properties:
        entity:
          $ref: '#/components/schemas/Entity'
        sharingType:
          type: string
          example: example_value
      examples:
      - entity:
          additionalLabel: null
          communityNickname: User1696423780773910041
          companyName: Salesforce
          displayName: Name
          firstName: firstName
          id: 005...
          isActive: true
          isInThisCommunity: true
          lastName: Name
          motif:
            color: 1B96FF
            largeIconUrl: /img/icon/profile64.png
            mediumIconUrl: /img/icon/profile32.png
            smallIconUrl: /img/icon/profile16.png
            svgIconUrl: null
          mySubscription: null
          name: Name
          outOfOffice:
            message: ''
          photo:
            fullEmailPhotoUrl: https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1
            largePhotoUrl: https://<my_domain>/profilephoto/7292o000000oAgZ/F
            mediumPhotoUrl: https://<my_domain>/profilephoto/7292o000000oAgZ/M
            photoVersionId: 729...
            smallPhotoUrl: https://<my_domain>/profilephoto/7292o000000oAgZ/T
            standardEmailPhotoUrl: https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1
            url: /services/data/v58.0/connect/user-profiles/005.../photo
          reputation: null
          title: null
          type: User
          url: /services/data/v58.0/chatter/users/005...
          userType: Internal
        sharingType: I
    SuccessfulFileShares:
      title: SuccessfulFileShares
      required:
      - currentPageUrl
      - linkShare
      - nextPageUrl
      - previousPageUrl
      - shares
      type: object
      properties:
        currentPageUrl:
          type: string
          example: https://www.example.com
        linkShare:
          type:
          - string
          - 'null'
          example: example_value
        nextPageUrl:
          type:
          - string
          - 'null'
          example: https://www.example.com
        previousPageUrl:
          type:
          - string
          - 'null'
          example: https://www.example.com
        shares:
          type: array
          items:
            $ref: '#/components/schemas/Share'
          description: ''
          example: []
      examples:
      - currentPageUrl: /services/data/v58.0/connect/files/069.../file-shares
        linkShare: null
        nextPageUrl: null
        previousPageUrl: null
        shares:
        - entity:
            additionalLabel: null
            communityNickname: User1696423780773910041
            companyName: Salesforce
            displayName: Name
            firstName: firstName
            id: 005...
            isActive: true
            isInThisCommunity: true
            lastName: Name
            motif:
              color: 1B96FF
              largeIconUrl: /img/icon/profile64.png
              mediumIconUrl: /img/icon/profile32.png
              smallIconUrl: /img/icon/profile16.png
              svgIconUrl: null
            mySubscription: null
            name: Name
            outOfOffice:
              message: ''
            photo:
              fullEmailPhotoUrl: https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1
              largePhotoUrl: https://<my_domain>/profilephoto/7292o000000oAgZ/F
              mediumPhotoUrl: https://<my_domain>/profilephoto/7292o000000oAgZ/M
              photoVersionId: 729...
              smallPhotoUrl: https://<my_domain>/profilephoto/7292o000000oAgZ/T
              standardEmailPhotoUrl: https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1
              url: /services/data/v58.0/connect/user-profiles/005.../photo
            reputation: null
            title: null
            type: User
            url: /services/data/v58.0/chatter/users/005...
            userType: Internal
          sharingType: I
    Photo:
      title: Photo
      required:
      - fullEmailPhotoUrl
      - largePhotoUrl
      - mediumPhotoUrl
      - photoVersionId
      - smallPhotoUrl
      - standardEmailPhotoUrl
      - url
      type: object
      properties:
        fullEmailPhotoUrl:
          type: string
          example: user@example.com
        largePhotoUrl:
          type: string
          example: https://www.example.com
        mediumPhotoUrl:
          type: string
          example: https://www.example.com
        photoVersionId:
          type: string
          example: '500123'
        smallPhotoUrl:
          type: string
          example: https://www.example.com
        standardEmailPhotoUrl:
          type: string
          example: user@example.com
        url:
          type: string
          example: https://www.example.com
      examples:
      - fullEmailPhotoUrl: https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1
        largePhotoUrl: https://<my_domain>/profilephoto/729.../F
        mediumPhotoUrl: https://<my_domain>/profilephoto/729.../M
        photoVersionId: 729...
        smallPhotoUrl: https://<my_domain>/profilephoto/729.../T
        standardEmailPhotoUrl: https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1
        url: /services/data/v58.0/connect/user-profiles/005.../photo
    SuccessfulFilesSharesLink:
      title: SuccessfulFilesSharesLink
      required:
      - expirationDate
      - fileViewUrl
      - isPasswordRequired
      - password
      - sharingType
      type: object
      properties:
        expirationDate:
          type:
          - string
          - 'null'
          example: example_value
        fileViewUrl:
          type: string
          example: https://www.example.com
        isPasswordRequired:
          type: boolean
          example: true
        password:
          type:
          - string
          - 'null'
          example: example_value
        sharingType:
          type: string
          example: example_value
      examples:
      - expirationDate: null
        fileViewUrl: https://<my_domain>/sfc/p/2o000000i6mB/a/2o00000022S3/y2zsu9pHtEVIa49w6ElaXdjXz_GxBSzRVwe645_Z.dw
        isPasswordRequired: false
        password: null
        sharingType: V
    Motif:
      title: Motif
      required:
      - color
      - largeIconUrl
      - mediumIconUrl
      - smallIconUrl
      - svgIconUrl
      type: object
      properties:
        color:
          type: string
          example: example_value
        largeIconUrl:
          type: string
          example: https://www.example.com
        mediumIconUrl:
          type: string
          example: https://www.example.com
        smallIconUrl:
          type: string
          example: https://www.example.com
        svgIconUrl:
          type:
          - string
          - 'null'
          example: https://www.example.com
      examples:
      - color: '939393'
        largeIconUrl: /img/content/content64.png
        mediumIconUrl: /img/content/content32.png
        smallIconUrl: /img/icon/files16.png
        svgIconUrl: null
    OutOfOffice:
      title: OutOfOffice
      required:
      - message
      type: object
      properties:
        message:
          type: string
          example: example_value
      examples:
      - message: ''
    Entity:
      title: Entity
      required:
      - additionalLabel
      - communityNickname
      - companyName
      - displayName
      - firstName
      - id
      - isActive
      - isInThisCommunity
      - lastName
      - motif
      - mySubscription
      - name
      - outOfOffice
      - photo
      - reputation
      - title
      - type
      - url
      - userType
      type: object
      properties:
        additionalLabel:
          type:
          - string
          - 'null'
          example: example_value
        communityNickname:
          type: string
          example: example_value
        companyName:
          type: string
          example: example_value
        displayName:
          type: string
          example: example_value
        firstName:
          type: string
          example: example_value
        id:
          type: string
          example: abc123
        isActive:
          type: boolean
          example: true
        isInThisCommunity:
          type: boolean
          example: true
        lastName:
          type: string
          example: example_value
        motif:
          $ref: '#/components/schemas/Motif'
        mySubscription:
          type:
          - string
          - 'null'
          example: example_value
        name:
          type: string
          example: Example Title
        outOfOffice:
          $ref: '#/components/schemas/OutOfOffice'
        photo:
          $ref: '#/components/schemas/Photo'
        reputation:
          type:
          - string
          - 'null'
          example: example_value
        title:
          type:
          - string
          - 'null'
          example: Example Title
        type:
          type: string
          example: example_value
        url:
          type: string
          example: https://www.example.com
        userType:
          type: string
          example: example_value
      examples:
      - additionalLabel: null
        communityNickname: User1696423780773910041
        companyName: Salesforce
        displayName: Name
        firstName: firstName
        id: 005...
        isActive: true
        isInThisCommunity: true
        lastName: Name
        motif:
          color: 1B96FF
          largeIconUrl: /img/icon/profile64.png
          mediumIconUrl: /img/icon/profile32.png
          smallIconUrl: /img/icon/profile16.png
          svgIconUrl: null
        mySubscription: null
        name: Name
        outOfOffice:
          message: ''
        photo:
          fullEmailPhotoUrl: https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1
          largePhotoUrl: https://<my_domain>/profilephoto/7292o000000oAgZ/F
          mediumPhotoUrl: https://<my_domain>/profilephoto/7292o000000oAgZ/M
          photoVersionId: 729...
          smallPhotoUrl: https://<my_domain>/profilephoto/7292o000000oAgZ/T
          standardEmailPhotoUrl: https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1
          url: /services/data/v58.0/connect/user-profiles/005.../photo
        reputation: null
        title: null
        type: User
        url: /services/data/v58.0/chatter/users/005...
        userType: Internal
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'OAuth 2.0 Bearer token obtained from the Salesforce OAuth 2.0 token endpoint. Include this token in the Authorization header as "Bearer {access_token}".

        '