Create User

Operation name

Create User

Function overview

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

= Remarks =

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

The data model of this component is table model type.

Properties

= Remarks =

For details on use of variables, refer to Variables.

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter a name that is used 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 a connection resource. Add A new connection resource can be added. Edit list Connection resource settings can be edited in > HULFT INTEGRATE > Connections.

Item name

Required/Optional

Use of variables

Description

Remarks

Destination

Required

Not available

Select a connection resource.

Add: A new connection resource can be added.
Edit list: Connection resource settings can be edited in > HULFT INTEGRATE > Connections.

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this connector.

Schemas

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	-	Repeats for the number of users to be created.
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". If omitted, "user" is set.
	language	Enter the language of the user.	Optional	Enter either "ja" or "en". If omitted, "ja" is set.
	is_sync_enabled	Enter whether the user will be able to use Box Sync.	Optional	If omitted, "true" is set.
	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). If omitted, "-1" is set.
	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	If omitted, "true" is set.
	timezone	Enter the time zone of the user.	Optional	Enter the time zone by using the time zone identifier format. Example: "Asia/Tokyo" If omitted, "Asia/Tokyo" is set.
	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". If omitted, "active" is set.

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	-	Repeats for the number of input items that failed in the processing.
column	result	When input is invalid, "skipped" is output. When request execution results in an error, "failed" is output.
	login	login of the input item that failed in the processing is output.
	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 in Mapper

The schema is loaded automatically.

= Remarks =

For details, refer to Edit Schema.

Mass data processing

Mass data processing isn't supported.

Transaction

Transaction isn't supported.

Parallel Stream Processing

PSP isn't supported.

Available component variables

Component variable name	Description	Remarks
succeeded_count	The number of input items that were processed successfully is stored.	The default value is 0.
failed_count	The number of input items that failed in the processing is stored.	The default value is 0.
skipped_count	The number of input items that were 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 error is stored.	The default value is null.
message_code	When an error occurs, the code of the message code corresponding to the error is stored.	The default value is null.
message_level	When an error occurs, the severity of the message code corresponding to the error is stored.	The default value is null.
error_type	When an error occurs, the error type is stored.	The default value is null. The format of the error type is as follows. Example: java.io.FileNotFoundException
error_message	When an error occurs, the error message is stored.	The default value is null.
error_trace	When an error occurs, the trace information for the error is stored.	The default value is null.

Message codes, exception messages, and limitations

Connector	Message code	Exception message	Limitations
Messages and limitations of the Box connector