User

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

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

詳細バリアントに含まれるフィールドは、fieldsパラメータをサポートするAPIエンドポイントによって返すことができます。たとえば、IDでファイルを取得するときに、fieldsリクエストパラメータをid,typeに設定すると、これらのフィールドのみがAPI応答で返されます。

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

ユーザーのタイムゾーン

true

ユーザーが自身の連絡先リストで会社の他のユーザーを参照できるかどうか

object

ユーザーの会社のレプリゼンテーション

11446498

この会社の一意の識別子。

enterprise

次の値に固定: enterprise

Acme Inc.

会社の名前

my-user-1234

ユーザーの検索に使用できる、アプリユーザーの外部識別子。これを使用して、外部IDプロバイダのユーザーIDをBoxユーザーに結び付けることが使用できます。

string
https://example.app.box.com/

ユーザーに対して生成する必要があるリンクのルート(プロトコル、サブドメイン、ドメイン)

true

会社のデバイス制限からユーザーを除外するかどうか

true

ユーザーが2要素認証を使用する必要があるかどうか

true

ユーザーが社外のユーザーとのコラボレーションを許可されているかどうか

true

ユーザーがApp Userであるかどうか

true

ユーザーがBox Syncを使用できるかどうか

string array
["important"]

ユーザーが所有するすべてのファイルとフォルダのタグ。返される値にはリクエスト元によって設定されたタグのみが含まれます。

string
admin

ユーザーの会社ロール

次の値のいずれか1つ: admin,coadmin,user

object array

追跡コードを使用すると、管理者は管理コンソールからレポートを生成し、特定のグループのユーザーに属性を割り当てることができます。この設定を使用するには、会社に対して有効にしておく必要があります。

tracking_code

次の値に固定: tracking_code

department

追跡コードの名前。管理コンソールであらかじめ設定 しておく必要があります

Sales

追跡コードの値

レスポンスの例

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