Users リソース - Box Dev Docs

Box APIは、管理対象ユーザーアカウントでログインする実際の従業員や、App Userを使用して強力な自動化ワークフローを推進するアプリケーションなど、さまざまなユーザーをサポートしています。

User

任意のユーザーAPIエンドポイントからデフォルトで返されるユーザーのStandard版の表示。

プロパティ	型	必須	説明
`id`	`string`	はい	このユーザーの一意の識別子。
`type`	`enum<string>`	はい	値は常に`user`になります。使用可能なオプション: `user`.
`name`	`string`	いいえ	このユーザーの表示名。
`login`	`string`	いいえ	このユーザーのプライマリメールアドレス。
`created_at`	`string`	いいえ	ユーザーオブジェクトが作成された日時。
`modified_at`	`string`	いいえ	ユーザーオブジェクトが最後に変更された日時。
`language`	`string`	いいえ	修正版のISO 639-1形式で表されるユーザーの言語。
`timezone`	`string`	いいえ	ユーザーのタイムゾーン。
`space_amount`	`integer`	いいえ	ユーザーが利用可能な容量の合計 (バイト数)。
`space_used`	`integer`	いいえ	ユーザーが現在使用している容量。
`max_upload_size`	`integer`	いいえ	ユーザーが所有できる個々のファイルの最大サイズ (バイト単位)。
`status`	`enum<string>`	いいえ	ユーザーのアカウントのステータス。使用可能なオプション: `active`, `inactive`, `cannot_delete_edit`, `cannot_delete_edit_upload`.
`job_title`	`string`	いいえ	ユーザーの役職。
`phone`	`string`	いいえ	ユーザーの電話番号。
`address`	`string`	いいえ	ユーザーの住所。
`avatar_url`	`string`	いいえ	ユーザーのアバター画像のURL。
`notification_email`	`object`	いいえ	通知メールが送信される代替の通知用メールアドレス。確認されると、通知メールはプライマリメールアドレスではなくこのメールアドレスに送信されます。 `null` を指定できます。

例

{
  "id": "11446498",
  "type": "user",
  "name": "Aaron Levie",
  "login": "ceo@example.com",
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "language": "en",
  "timezone": "Africa/Bujumbura",
  "space_amount": 11345156112,
  "space_used": 1237009912,
  "max_upload_size": 2147483648,
  "status": "active",
  "job_title": "CEO",
  "phone": "6509241374",
  "address": "900 Jefferson Ave, Redwood City, CA 94063",
  "avatar_url": "https://www.box.com/api/avatar/large/181216415",
  "notification_email": {
    "email": "notifications@example.com",
    "is_confirmed": true
  }
}

Users

ユーザーのリスト。

属性と例

プロパティ	型	必須	説明
`limit`	`integer`	いいえ	これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。
`next_marker`	`string`	いいえ	次の検索結果ページの開始場所のマーカー。 `null` を指定できます。
`prev_marker`	`string`	いいえ	前の検索結果ページの開始場所のマーカー。 `null` を指定できます。
`total_count`	`integer`	いいえ	コレクション全体の最後のエントリのオフセットに1を加算した値。コレクション内のエントリの合計数は、`total_count`よりも少ない場合があります。このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。
`offset`	`integer`	いいえ	このセットに含まれる最初のエントリのゼロから始まるオフセット。これは、`offset`クエリパラメータと同じになります。このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。
`order`	array of `object`	いいえ	項目が返される順序。このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。
`entries`	array of ユーザー (Full)	いいえ	ユーザーのリスト。

例

{
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
  "total_count": 5000,
  "offset": 2000,
  "order": [
    {
      "by": "type",
      "direction": "ASC"
    }
  ],
  "entries": [
    {
      "id": "11446498",
      "type": "user",
      "name": "Aaron Levie",
      "login": "ceo@example.com",
      "created_at": "2012-12-12T10:53:43-08:00",
      "modified_at": "2012-12-12T10:53:43-08:00",
      "language": "en",
      "timezone": "Africa/Bujumbura",
      "space_amount": 11345156112,
      "space_used": 1237009912,
      "max_upload_size": 2147483648,
      "status": "active",
      "job_title": "CEO",
      "phone": "6509241374",
      "address": "900 Jefferson Ave, Redwood City, CA 94063",
      "avatar_url": "https://www.box.com/api/avatar/large/181216415",
      "notification_email": {
        "email": "notifications@example.com",
        "is_confirmed": true
      },
      "role": "admin",
      "tracking_codes": [
        {
          "type": "tracking_code",
          "name": "department",
          "value": "Sales"
        }
      ],
      "can_see_managed_users": true,
      "is_sync_enabled": true,
      "is_external_collab_restricted": true,
      "is_exempt_from_device_limits": true,
      "is_exempt_from_login_verification": true,
      "enterprise": {
        "id": "11446498",
        "type": "enterprise",
        "name": "Acme Inc."
      },
      "my_tags": [
        "important"
      ],
      "hostname": "https://example.app.box.com/",
      "is_platform_access_only": true,
      "external_app_user_id": "my-user-1234"
    }
  ]
}

ユーザー (Base)

他のリソース内にネストされたときに使用されるユーザーのMini版の表示。

属性と例

プロパティ	型	必須	説明
`id`	`string`	はい	このユーザーの一意の識別子。
`type`	`enum<string>`	はい	値は常に`user`になります。使用可能なオプション: `user`.

例

{
  "id": "11446498",
  "type": "user"
}

ユーザー (Full)

任意のユーザーAPIエンドポイントから返される可能性があるユーザーのFull版の表示。

属性と例

プロパティ	型	必須	説明
`id`	`string`	はい	このユーザーの一意の識別子。
`type`	`enum<string>`	はい	値は常に`user`になります。使用可能なオプション: `user`.
`name`	`string`	いいえ	このユーザーの表示名。
`login`	`string`	いいえ	このユーザーのプライマリメールアドレス。
`created_at`	`string`	いいえ	ユーザーオブジェクトが作成された日時。
`modified_at`	`string`	いいえ	ユーザーオブジェクトが最後に変更された日時。
`language`	`string`	いいえ	修正版のISO 639-1形式で表されるユーザーの言語。
`timezone`	`string`	いいえ	ユーザーのタイムゾーン。
`space_amount`	`integer`	いいえ	ユーザーが利用可能な容量の合計 (バイト数)。
`space_used`	`integer`	いいえ	ユーザーが現在使用している容量。
`max_upload_size`	`integer`	いいえ	ユーザーが所有できる個々のファイルの最大サイズ (バイト単位)。
`status`	`enum<string>`	いいえ	ユーザーのアカウントのステータス。使用可能なオプション: `active`, `inactive`, `cannot_delete_edit`, `cannot_delete_edit_upload`.
`job_title`	`string`	いいえ	ユーザーの役職。
`phone`	`string`	いいえ	ユーザーの電話番号。
`address`	`string`	いいえ	ユーザーの住所。
`avatar_url`	`string`	いいえ	ユーザーのアバター画像のURL。
`notification_email`	`object`	いいえ	通知メールが送信される代替の通知用メールアドレス。確認されると、通知メールはプライマリメールアドレスではなくこのメールアドレスに送信されます。 `null` を指定できます。
`role`	`enum<string>`	いいえ	ユーザーの企業でのロール。使用可能なオプション: `admin`, `coadmin`, `user`.
`tracking_codes`	array of `追跡コード`	いいえ	追跡コードを使用すると、管理者は管理コンソールからレポートを生成し、特定のグループのユーザーに属性を割り当てることができます。この設定を使用するには、会社に対して有効にしておく必要があります。
`can_see_managed_users`	`boolean`	いいえ	ユーザーが自身の連絡先リストで企業の他のユーザーを参照できるかどうか。
`is_sync_enabled`	`boolean`	いいえ	ユーザーがBox Syncを使用できるかどうか。
`is_external_collab_restricted`	`boolean`	いいえ	ユーザーが社外のユーザーとのコラボレーションを許可されているかどうか。
`is_exempt_from_device_limits`	`boolean`	いいえ	企業のデバイス制限からユーザーを除外するかどうか。
`is_exempt_from_login_verification`	`boolean`	いいえ	ユーザーが2要素認証を使用する必要があるかどうか。
`enterprise`	`object`	いいえ	Box Enterpriseのレプリゼンテーション。
`my_tags`	array of `string`	いいえ	ユーザーが所有するすべてのファイルとフォルダのタグ。返される値にはリクエスト元によって設定されたタグのみが含まれます。
`hostname`	`string`	いいえ	ユーザーに対して生成する必要があるリンクのルート (プロトコル、サブドメイン、ドメイン)。
`is_platform_access_only`	`boolean`	いいえ	ユーザーがApp Userであるかどうか。
`external_app_user_id`	`string`	いいえ	ユーザーの検索に使用できる、App Userの外部識別子。これを使用して、外部IDプロバイダのユーザーIDをBoxユーザーに結び付けることができます。

例

{
  "id": "11446498",
  "type": "user",
  "name": "Aaron Levie",
  "login": "ceo@example.com",
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "language": "en",
  "timezone": "Africa/Bujumbura",
  "space_amount": 11345156112,
  "space_used": 1237009912,
  "max_upload_size": 2147483648,
  "status": "active",
  "job_title": "CEO",
  "phone": "6509241374",
  "address": "900 Jefferson Ave, Redwood City, CA 94063",
  "avatar_url": "https://www.box.com/api/avatar/large/181216415",
  "notification_email": {
    "email": "notifications@example.com",
    "is_confirmed": true
  },
  "role": "admin",
  "tracking_codes": [
    {
      "type": "tracking_code",
      "name": "department",
      "value": "Sales"
    }
  ],
  "can_see_managed_users": true,
  "is_sync_enabled": true,
  "is_external_collab_restricted": true,
  "is_exempt_from_device_limits": true,
  "is_exempt_from_login_verification": true,
  "enterprise": {
    "id": "11446498",
    "type": "enterprise",
    "name": "Acme Inc."
  },
  "my_tags": [
    "important"
  ],
  "hostname": "https://example.app.box.com/",
  "is_platform_access_only": true,
  "external_app_user_id": "my-user-1234"
}

ユーザー (Mini)

他のリソース内にネストされたときに返される可能性があるユーザーのMini版の表示。

属性と例

プロパティ	型	必須	説明
`id`	`string`	はい	このユーザーの一意の識別子。
`type`	`enum<string>`	はい	値は常に`user`になります。使用可能なオプション: `user`.
`name`	`string`	いいえ	このユーザーの表示名。
`login`	`string`	いいえ	このユーザーのプライマリメールアドレス。

例

{
  "id": "11446498",
  "type": "user",
  "name": "Aaron Levie",
  "login": "ceo@example.com"
}

ユーザー (コラボレーション)

ユーザーのMini版の表示は、ステータスがpendingの場合にのみ返すことができます。

属性と例

プロパティ	型	必須	説明
`id`	`string`	はい	このユーザーの一意の識別子。
`type`	`enum<string>`	はい	値は常に`user`になります。使用可能なオプション: `user`.
`name`	`string`	いいえ	このユーザーの表示名。コラボレーションのステータスが`pending`の場合、空の文字列が返されます。
`login`	`string`	いいえ	このユーザーのプライマリメールアドレス。コラボレーションステータスが`pending`の場合、ログイン値が返されます。
`is_active`	`boolean`	いいえ	`false`に設定した場合、ユーザーは非アクティブになるか削除されます。

例

{
  "id": "11446498",
  "type": "user",
  "name": "Aaron Levie",
  "login": "ceo@example.com",
  "is_active": true
}

ユーザー (統合マッピング)

統合マッピングAPIのためのユーザーのレプリゼンテーション。フィールド名とログインは必要ありません。

属性と例

プロパティ	型	必須	説明
`id`	`string`	はい	このユーザーの一意の識別子。
`type`	`enum<string>`	はい	値は常に`user`になります。使用可能なオプション: `user`.
`name`	`string`	いいえ	このユーザーの表示名。
`login`	`string`	いいえ	このユーザーのプライマリメールアドレス。

例

{
  "id": "11446498",
  "type": "user",
  "name": "Aaron Levie",
  "login": "ceo@example.com"
}

​User

​Users

​ユーザー (Base)

​ユーザー (Full)

​ユーザー (Mini)

​ユーザー (コラボレーション)

​ユーザー (統合マッピング)

User

Users

ユーザー (Base)

ユーザー (Full)

ユーザー (Mini)

ユーザー (コラボレーション)

ユーザー (統合マッピング)