On this Page

Overview

Snap type:

Write


Description:

This Snap creates a user in Box. You must enable the scope to Manage an enterprise in Box to use this Snap to perform enterprise management.  
  • Expected upstream Snaps: File Reader followed by any file parser, followed by Structure.  
  • Expected downstream Snaps: CSV Formatter followed by File Writer.
  • Expected input:  User name and User login. For more information about all the Box user properties required to create/provision a Box user, see Box Documentation.
  • Expected output: Creates a user in Box.


Prerequisites:

Enable the scope to Manage an enterprise in Box to use this Snap to perform enterprise management.


Support and limitations:Works in Ultra Pipelines.
Account: 

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Configuring Box Accounts for information on setting up this type of account.


Views:


InputThis Snap has exactly one document input view.
OutputThis Snap has exactly one document output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view.


Settings

Label


Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Number of Retries



Enter the integer value to specify the number of attempts the snap should make to perform the selected operation in case of connection failure or timeout.

Example: 3

Minimum value: 0

Default value: 3

Retry Interval (seconds)

Enter the time interval in seconds between retry attempts.

Example: 1

Minimum value: 1

Default value: 5

Example

To create a user in Box, supply the following property values in the upstream Snap, followed by Structure before the Box Create User Snap:

  • User name: Snapuser (Name of the user to be created)
  • User login: Snaps.Snaplogic@example.com (Enter a valid email address for the user)

such as the following JSON example:

{
    "username": "Snapuser",
    "login": "Snap.Snaplogic@example.com"
}