/
Box Update User

Box Update User

Jun 09, 2021

On this Page

Overview

Snap type:

Write

 

Description:

This Snap is used for updating a user in Box. The prerequisite for this Snap is that Manage an enterprise scope needs to be enabled in Box to perform enterprise management.

  • Expected upstream Snaps: File reader, JSON Generator, or any upstream Snap, followed by Structure.

  • Expected downstream Snaps: CSV Formatter followed by File Writer.

  • Expected input: InputScheme, userID is required.  For more information about all the Box user properties that can be updated, see Box Documentation.

  • Expected output: The updated Box user object.

 

Prerequisites:

[None]

 

Support and limitations:

Works in Ultra Tasks.

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:

Input

This Snap has exactly one document input view.

Output

This Snap has exactly one document output view.

Error

This Snap has at most one document error view and produces zero or more documents in the view.

 

The first document in the input view must contain a complete set of key names. If additional key names appear in the subsequent input documents, then the Snap may produce inaccurate results in the output.

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: 3

Minimum value: 1

Default value: 5

Example

To update a user in Box, supply the following property values in an upstream Snap (followed by a Structure Snap):

user ID: 123456 (ID of the user to be updated. This is a required value)

name:  Snaplogic (Name of the user to be updated)