Box

Boxを業務アセットとして接続するために必要な準備と、接続後に管理できる対象を説明します。Box側でのカスタムアプリの作成が事前に必要です。

概要

Boxは、クラウドコンテンツ管理とファイル共有のためのオンラインストレージサービスです。

参照先	リンク
公式サイト	AIを活用したセキュアなコンテンツ管理、ワークフロー、コラボレーション
サービス概要	AIと非構造化データ：新しい時代の始まり Box
APIドキュメント	User - APIリファレンス - Box Developerドキュメント

YESODがBoxと連携して提供する機能は次の3つです。

Boxのアカウントの作成
Boxのロール・グループの割当の付与・剥奪
Boxのアカウント作成時の初期フォルダーの作成

既存のフォルダーの更新・削除には対応していません。

管理できること

機能	対応
アカウント作成	○
グループ付与	○
ロール付与	○

接続方式は標準コネクタです。

接続に使う情報

入力項目	必須	入力する内容
「エンタープライズID」	必須	Boxの開発者コンソールで確認できるエンタープライズID
「クライアントID」	必須	カスタムアプリのクライアントID
「クライアントシークレット」	必須	カスタムアプリのクライアントシークレット

3つとも、Boxの開発者コンソールで取得します。クライアントシークレットは第三者に共有せず、安全な場所で管理してください。

接続の準備

接続する前に、Boxでカスタムアプリを作成します。Box側での作業です。

Boxの開発者コンソールで「マイPlatformアプリ」を開きます。
「Platformアプリの作成」をクリックします。
アプリの種類で「カスタムアプリ」を選択します。
認証方法で「サーバー認証(クライアント資格情報許可)」を選択します。
作成されたアプリを選択します。
「構成」タブを開きます。
アプリアクセスレベルで「アプリ + Enterpriseアクセス」を選択します。
アプリケーションスコープで、次の3つにチェックが入っていることを確認します。
- 「ユーザーを管理する」
- 「グループを管理する」
- 「Enterpriseのプロパティを管理する」
「高度な機能」で、次の2つにチェックを入れます。
- 「as-userヘッダーを使用してAPIコールを行う」
- 「ユーザーアクセストークンを生成する」
承認作業をします。管理者のメールアドレスへ、承認を求めるメールが送信されます。

注意

Boxのカスタムアプリは、設定を変更するたびに管理者の承認が必要です。初回の承認では承認を求めるメールが送信されますが、再承認ではメールが送信されません。2回目以降は、Boxの管理コンソールで承認してください。初回と2回目以降で手順が変わります。

参考にするBox Developerドキュメントは次のとおりです。

接続する

「業務アセット」画面から「SaaS接続」画面を開くまでの手順は、業務アセットを追加するを参照してください。

「SaaS接続」画面で「Box」を選択します。「Box 接続」画面が表示されます。
「エンタープライズID」「クライアントID」「クライアントシークレット」を入力します。
「接続」ボタンをクリックします。同期が完了すると、業務アセットが作成されます。

アカウントの作成

パスワードの作成には対応していません。BoxのAPIはユーザーを招待するだけで、パスワードを扱えないためです。

アカウントを作成すると、Boxから対象のメールアドレスへURLが送信されます。ユーザーはそのURLでパスワードを作成すると、Boxを使えるようになります。

割当種別

割当種別	タイプ	割当項目	説明
ロール	優先度の高いグループに所属させる	`coadmin`（共同管理者）／`user`（管理対象ユーザー）	Boxの管理コンソールのアクセス権を管理します
グループ	複数のグループに所属させる	BoxのAPIから取得します	グループを使うと、複数のユーザーへ一括でフォルダーのアクセス権限を付与できます

coadminは管理者権限を持つユーザー、userは管理者権限を持たないユーザーです。

Boxのグループについては、グループの作成と管理を参照してください。

同期する項目

業務アセットの「アカウント設定」にある「同期する項目」で、YESODの項目をBoxの項目へ対応づけます。

必須項目

項目	マッピング項目	YESOD項目	型	説明
`login`	`user.login`	`user.email`	String	Boxへのアクセスに使うメールアドレス。変更できません（Boxの管理画面でも変更できません）
`name`	`user.name`	`user.familyNameLocalPreferred + " " + user.givenNameLocalPreferred`	String	ユーザー名

任意項目

マッピング項目	入力形式	説明	BOXキー名
`user.language`	string	ユーザーの言語（ISO 639-1形式）	`language`
`user.timezone`	string	タイムゾーン	`timezone`
`user.space_amount`	integer	ストレージ使用量（バイト）。`-1`で無制限	`space_amount`
`user.job_title`	string	役職（最大100文字）	`job_title`
`user.phone`	string	電話番号（最大100文字）	`phone`
`user.address`	string	住所（最大255文字）	`address`
`user.is_sync_enabled`	boolean	Box Sync使用可否	`is_sync_enabled`
`user.is_external_collab_restricted`	boolean	ユーザーが社外のユーザーとのコラボレーションを許可されているかどうか	`is_external_collab_restricted`
`user.is_exempt_from_device_limits`	boolean	会社のデバイス制限からユーザーを除外するかどうか	`is_exempt_from_device_limits`
`user.can_see_managed_users`	boolean	ユーザーが自身の連絡先リストで会社の他のユーザーを参照できるかどうか	`can_see_managed_users`
`user.is_exempt_from_login_verification`	boolean	ユーザーが2要素認証を使用する必要があるかどうか	`is_exempt_from_login_verification`
`user.email_aliases[0].email`	Stringの配列	メールエイリアス（企業の登録済みドメインのみ）。洗い替えのため、指定していないメールエイリアスは削除されます。`null`を指定すると、すべてのメールエイリアスが削除されます	`email_aliases[]`
`user.initial_folder_enabled`	boolean	新規フォルダーを作成するかどうかの設定（未設定の場合は`false`）	—
`user.initial_folder_path`	String	親フォルダーのフルパス	—
`user.initial_folder_name`	String	新規フォルダーの名称	—

検討の結果、対応外とした項目

項目	内容
`status`	アカウント状態（`active` / `inactive` / `cannot_delete_edit` / `cannot_delete_edit_upload`）。ユーザーの有効・無効を`active`と`inactive`で管理しており、同じ項目でユーザーの権限にあたる部分も設定できます
`enterprise`	`null`にすると会社メンバーから外れ、無料ユーザーになります
`tracking_codes[]`	トラッキングコード（Boxの管理コンソールでの事前設定が必要）
`is_password_reset_required`	パスワードリセットを義務付けるかどうか（`false`から`true`への変更のみ）
`notification_email.email`	代替の通知用メールアドレス

注記

Boxでは、アカウントを作成した直後は通知メールの項目が非活性で、パスワードリセットに関する項目も表示されません。ユーザーがパスワードを設定すると、どちらも入力できるようになります。

ドキュメントに記載されているが、対応外とした項目

マッピング項目	入力形式	説明	BOXキー名
`user.notify`	boolean	会社メンバーでなくなった後もメール受信可能か	`notify`

notifyはBoxのAPIドキュメントに記載がありますが、次の理由から対応していません。

Boxが提供しているSDKに項目がない
curlでAPIを直接実行しても値が変わらない
Boxの管理画面に対応する項目がない

概要​

管理できること​

接続に使う情報​

接続の準備​

接続する​

アカウントの作成​

割当種別​

同期する項目​

必須項目​

任意項目​

検討の結果、対応外とした項目​

ドキュメントに記載されているが、対応外とした項目​

関連ページ​

概要