Box Create User
creates a user in Box.
Overview
Write-type Snap
-
Works in Ultra Pipelines
This Snap creates a user in Box.
- 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.
Enable the scope to Manage an enterprise in Box to use this Snap to perform enterprise management.
Limitations and known issues
None.
Snap Views
View | Description | Examples of upstream and downstream Snaps |
---|---|---|
Input | This Snap has at most one document input view. | |
Output | This Snap has exactly one document output view. | |
Error |
Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:
Learn more about Error handling in Pipelines. |
Snap settings
-
Suggestion icon (
): Indicates a list that is dynamically populated based on the configuration.
-
Expression icon (
): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
-
Add icon (
): Indicates that you can add fields in the field set.
-
Remove icon (
): Indicates that you can remove fields from the field set.
Field / Field set | Type | Description |
---|---|---|
Label | String | 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.
Default status: Example: |
Number of retries | Integer | 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.
Default status: 3 Mininum value: 0 Example: 3 |
Retry interval (seconds) | Integer | Enter the time interval in seconds between retry attempts.
Example: 1 Mininum value: 1 Default status: 5 |
Snap execution | Dropdown list | Select one of the three modes in which the Snap executes.
Available options are:
|
Troubleshooting
None.
Example
- 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"
}