Create User

Operation Name

Create User

Function Overview

In Box, create the user specified in the input data.

For details on API specifications used by this component, refer to the Box API reference at the following URL.

https://developer.box.com/reference/post-users/

Data Model

Data model of this type of component is table model type.

Properties

For details on using variables, refer to "Variables".

Basic Settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter the name on the script canvas.
Input data	Required	Not available	Select a component on the script canvas.

Required Settings

Item name	Required/Optional	Use of variables	Description	Remarks
Destination	Required	Not available	Select Global Resources. For details on global resource settings, refer to "Global resource properties". [Add]: Add a new global resource. [Edit list]: Allows you to edit the global resource settings in "Edit resource list".

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this adapter. The description will be applied to the specifications.

Schema

Input Schema

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>login</column>
    <column>name</column>
    <column>role</column>
    <column>language</column>
    <column>is_sync_enabled</column>
    <column>job_title</column>
    <column>phone</column>
    <column>address</column>
    <column>space_amount</column>
    <column>can_see_managed_users</column>
    <column>timezone</column>
    <column>is_exempt_from_device_limits</column>
    <column>is_exempt_from_login_verification</column>
    <column>status</column>
  </row>
  <row>
    :
  </row>
</table>

Element name	Label	Description	Required/Optional	Remarks
row	-	Repeat the creation of users for each row.
column	login	Enter the email address that the user uses to log in.	Required
	name	Enter the name of the user.	Required
	role	Enter the user's enterprise role in Box.	Optional	Enter either "coadmin" or "user". Defaults to "user" if omitted.
	language	Enter the language of the user.	Optional	Enter either "ja" or "en". Defaults to "ja" if omitted.
	is_sync_enabled	Enter whether the user will be able to use Box Sync.	Optional	Defaults to "true" if omitted.
	job_title	Enter the job title of the user.	Optional
	phone	Enter the phone number of the user.	Optional
	address	Enter the address of the user.	Optional
	space_amount	Enter the amount of storage space (units: gigabytes) available to the user.	Optional	Enter a positive integer or "-1" (unlimited). Defaults to "-1" if omitted.
	can_see_managed_users	Enter whether the user will be able to use their own contact list to browse for other users of the enterprise on Box.	Optional	Defaults to "true" if omitted.
	timezone	Enter the time zone of the user.	Optional	Enter the time zone by using the time zone identifier format. Ex., "Asia/Tokyo" Defaults to "Asia/Tokyo" if omitted.
	is_exempt_from_device_limits	Enter whether the user will be exempt from enterprise device limitations on Box.	Optional	If omitted, "false" is set.
	is_exempt_from_login_verification	Enter whether the user is required to use two-factor authentication.	Optional	If omitted, "false" is set.
	status	Enter the account status of the user.	Optional	Enter "active", "inactive", "cannot_delete_edit", or "cannot_delete_edit_upload". Defaults to "active" if omitted.

Output Schema

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>result</column>
    <column>login</column>
    <column>status_code</column>
    <column>error_code</column>
    <column>message</column>
    <column>request_id</column>
  </row>
  <row>
    :
  </row>
</table>

Element name	Label	Description
row	-	Repeat the input process the number of times that input failed in the processing.
column	result	When input is incorrect, "skipped" is output. When the request execution result is an error, "failed" is output.
	login	Output login for input that failed in the processing.
	status_code	If the result is "failed", an HTTP status code is output from Box.
	error_code	If the result is "failed", an error code that identifies the error contents is output.
	message	An error message is output.
	request_id	If the result is "failed", the ID that uniquely distinguishes the request relative to Box is output.

Loading Schema on Mapper

The schema is loaded automatically.

For details, refer to "Edit schema".

Mass Data Processing

Mass data processing is not supported.

Transaction

Transaction is not supported.

PSP Usage

PSP is not supported.

Available Component Variables

Component variable name	Description	Remarks
succeeded_count	The number of times that input was successful in the processing is stored.	The default value is "0".
failed_count	The number of times that input failed in the processing is stored.	The default value is "0".
skipped_count	The number of times that input that was skipped in the processing is stored.	The default value is "0".
message_category	When an error occurs, the category of the message code corresponding to the occurred error is stored.	The default value is null.
message_code	When an error occurs, the code of the message code corresponding to the occurred error is stored.	The default value is null.
message_level	When an error occurs, the severity of the message code corresponding to the occurred error is stored.	The default value is null.
error_type	When an error occurs, the type of an occurred error is stored.	The default value is null. The error type will be in the following format. Example: "java.io.FileNotFoundException" The contents to be stored may vary depending on the version of DataSpider Servista.
error_message	When an error occurs, the message of the occurred error is stored.	The default value is null. The contents to be stored may vary depending on the version of DataSpider Servista.
error_trace	When an error occurs, the trace information of the occurred error is stored.	The default value is null. The contents that will be stored may vary depending on the version and client applications of DataSpider Servista.

Specification Limits

The processing of input data is executed one line at a time. Therefore, even if an error occurs during processing, the data which have been deleted are applied.

If an error occurs during processing, some of the input data and the error details are output in the results data, and then processing continues.

Major Exceptions

Exception Name	Cause	Solution
ResourceNotFoundException Resource definition is not found. Name:[]	[Destination] is not specified.	Specify a value for [Destination].
ResourceNotFoundException Resource definition is not found. Name:[<Name of global resources>]	Resource definition selected in [Destination] is not found.	Check the global resource specified in [Destination].