ユーザー (Full) - Box Dev Docs

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

このリソースにはAPIの使用時に発生する可能性があるいくつかのバリエーションがあります。Fullバリアントに含まれるフィールドは、fieldsパラメータをサポートするAPIエンドポイントによって返すことができます。たとえば、IDでファイルを取得するときに、fieldsリクエストパラメータをid,typeに設定すると、これらのフィールドのみがAPIレスポンスで返されます。

string

例 11446498このユーザーの一意の識別子。

type

string

例 user値は常にuserになります。次の値に固定: user

address

string

例 900 Jefferson Ave, Redwood City, CA 94063ユーザーの住所。

avatar_url

string

例 https://www.box.com/api/avatar/large/181216415ユーザーのアバター画像のURL。

can_see_managed_users

boolean

例 trueユーザーが自身の連絡先リストで企業の他のユーザーを参照できるかどうか。

created_at

string(date-time)

例 2012-12-12T10:53:43-08:00ユーザーオブジェクトが作成された日時。

enterprise

object

ユーザーの企業のレプリゼンテーション。

表示子属性

string

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

type

string

例 enterprise値は常にenterpriseになります。次の値に固定: enterprise

name

string

例 Acme Inc.企業の名前。

external_app_user_id

string

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

hostname

string

例 https://example.app.box.com/ユーザーに対して生成する必要があるリンクのルート (プロトコル、サブドメイン、ドメイン)。

is_exempt_from_device_limits

boolean

例 true企業のデバイス制限からユーザーを除外するかどうか。

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

is_external_collab_restricted

boolean

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

is_platform_access_only

boolean

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

is_sync_enabled

boolean

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

job_title

string

例 CEOユーザーの役職。

language

string

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

例 ceo@example.comこのユーザーのプライマリメールアドレス。

max_upload_size

integer(int64)

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

modified_at

string(date-time)

例 2012-12-12T10:53:43-08:00ユーザーオブジェクトが最後に変更された日時。

my_tags

stringarray

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

name

string

例 Aaron Levieこのユーザーの表示名。

notification_email

object

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

表示子属性

string

例 notifications@example.com通知を送付するメールアドレス。

is_confirmed

boolean

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

phone

string

例 6509241374ユーザーの電話番号。

role

string

例 adminユーザーの企業でのロール。次の値のいずれか1つ: admin,coadmin,user

space_amount

integer(int64)

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

space_used

integer(int64)

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

status

string

例 activeユーザーのアカウントのステータス。次の値のいずれか1つ: active,inactive,cannot_delete_edit,cannot_delete_edit_upload

timezone

string(timezone)

例 Africa/Bujumburaユーザーのタイムゾーン。

tracking_codes

object[]

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

表示子属性

type

string

例 tracking_code値は常にtracking_codeになります。次の値に固定: tracking_code

name

string

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

value

string

例 Sales追跡コードの値。

{
  "id": "11446498",
  "type": "user",
  "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",
    "type": "enterprise",
    "name": "Acme Inc."
  },
  "external_app_user_id": "my-user-1234",
  "hostname": "https://example.app.box.com/",
  "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": [
    {
      "name": "department",
      "type": "tracking_code",
      "value": "Sales"
    }
  ]
}