User

任意のユーザーAPIエンドポイントから返される可能性がある、ユーザーの完全版レプリゼンテーション。

基本
簡易
標準

このリソースにはAPIの使用時に発生する可能性があるいくつかのバリエーションがあります。

通常、標準バリアントに含まれるフィールドは、固有のAPIエンドポイントを介してこのリソースがリクエストされたときに返されます。 たとえば、fieldsパラメータが指定されていない場合、IDでファイルを取得すると、これらのフィールドが返されます。

string
11446498

このオブジェクトの一意の識別子

string
user

次の値に固定: user

string / email
ceo@example.com

このユーザーのプライマリメールアドレス

string
Aaron Levie50

このユーザーの表示名

string
900 Jefferson Ave, Redwood City, CA 94063255

ユーザーの住所

string
https://www.box.com/api/avatar/large/181216415

ユーザーのアバター画像のURL

string / date-time
2012-12-12T10:53:43-08:00

ユーザーオブジェクトが作成された日時

string
CEO100

ユーザーの役職

string
en

修正版のISO 639-1形式で表されるユーザーの言語。

2147483648

ユーザーが所有できる個々のファイルの最大サイズ(バイト単位)

string / date-time
2012-12-12T10:53:43-08:00

ユーザーオブジェクトが最後に変更された日時

通知メールが送信される代替の通知用メールアドレス。確認されると、通知メールはプライマリメールアドレスではなくこのメールアドレスに送信されます。

notifications@example.com

通知を送付するメールアドレス。

true

このメールアドレスが確認されたかどうかを指定します。

string
6509241374100

ユーザーの電話番号

integer
11345156112

ユーザーが利用可能な容量の合計(バイト数)

integer
1237009912

ユーザーが現在使用している容量

string
active

ユーザーのアカウントのステータス

次の値のいずれか1つ: active,inactive,cannot_delete_edit,cannot_delete_edit_upload

string / timezone
Africa/Bujumbura

ユーザーのタイムゾーン

詳細

レスポンスの例

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