Box v2

Manage Box users.

IT Services · Box

Configuration parameters

  • url — Server URL (required)
  • insecure — Trust any certificate (not secure)
  • credentials_json — Credentials JSON
  • cred_json —
  • as_user — User ID for Fetching Incidents
  • event_type — Types of Events to Ingest as Incidents
  • default_user — Default User
  • search_user_id — Auto-detect user IDs based on their email address.
  • incidentType — Incident type
  • isFetch — Fetch incidents
  • first_fetch — First fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days)
  • max_fetch — The maximum amount of incidents to fetch at once

Commands (27)

  • box-create-file-share-link

    Adds a shared link to a file.

  • box-create-folder-share-link

    Adds a shared link to a folder.

  • box-create-user

    Creates a new managed user in an enterprise. This endpoint is only available to users and applications with the correct admin permissions.

  • box-delete-user

    Deletes a user. By default this will fail if the user still owns any content. Move their owned content before proceeding, or use the force field to delete the user and their files.

  • box-download-file

    Returns the contents of a file in binary format.

  • box-file-delete

    Deletes a file, either permanently or by moving it to the trash.

  • box-find-file-folder-by-share-link

    Return the file represented by a shared link.

  • box-folder-create

    Creates a new empty folder within the specified parent folder.

  • box-get-current-user

    Retrieves information about the user who is currently authenticated.

  • box-get-folder

    Retrieves details for a folder, including the first 100 entries in the folder.

  • box-get-shared-link-by-file

    Gets the information for a shared link on a file.

  • box-get-shared-link-by-folder

    Gets the information for a shared link on a folder.

  • box-list-enterprise-events

    Returns up to a year of past events for the entire enterprise.

  • box-list-folder-items

    Retrieves a page of items in a folder.

  • box-list-user-events

    Returns up to a year of past events for a given user.

  • box-list-users

    Returns a list of all users for the Enterprise along with their user_id, public_name, and login.

  • box-move-folder

    Move all of the items (files, folders and workflows) owned by a user into another user's account.

  • box-remove-file-share-link

    Removes a shared link from a file.

  • box-remove-folder-share-link

    Removes a shared link from a folder.

  • box-search-content

    Searches for files, folders, web links, and shared files across the users' content or across the entire enterprise.

  • box-trashed-item-delete-permanently

    Permanently deletes a file or folder that is in the trash. This action cannot be undone.

  • box-trashed-item-restore

    Restores a file or folder that has been moved to the trash.

  • box-trashed-items-list

    Retrieves the files and folders that have been moved to the trash.

  • box-update-file-share-link

    Updates a shared link on a file.

  • box-update-folder-share-link

    Updates a shared link on a folder.

  • box-update-user

    Updates a managed user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.

  • box-upload-file

    Uploads a file to the given folder.