会社ユーザーのリストを取得

get
https://api.box.com/2.0
/users/

会社の全ユーザーのリストを、各ユーザーのuser_idpublic_nameloginとともに返します。

会社全体のユーザーを参照するには、アプリケーションと認証済みユーザーに適切な権限が付与されている必要があります。

リクエスト

Bearer [ACCESS_TOKEN]
application/json

クエリパラメータ

stringクエリ内省略可能
my-user-1234

指定したexternal_app_user_id値を持つアプリユーザーに結果を絞り込みます。

アプリユーザーの作成時に、external_app_user_id値を設定できます。その後、この値をこのエンドポイントで使用すると、そのexternal_app_user_id値に一致するすべてのユーザーが見つかります。

string arrayクエリ内省略可能
id,type,name

応答に含める属性のカンマ区切りリスト。このパラメータを使用すると、標準の応答には通常含まれないフィールドをリクエストできます。

このパラメータを指定すると、明示的に指定しない限り標準フィールドは応答に含まれず、リクエストしたフィールドのほかには、簡易版レプリゼンテーションのフィールドしか返されないことに注意してください。

stringクエリ内省略可能
john

nameまたはloginが検索語で始まるユーザーのみに結果を絞り込みます。

外部で管理されているユーザーを検索するには、ユーザー名またはログインが検索語と完全に一致している必要があります。 同時に返されるユーザーは1人のみです。

integer / int64クエリ内省略可能
10001000

返す項目の1ページあたりの最大数。

stringクエリ内省略可能
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。

これを使用するには、usemarkertrueに設定する必要があります。

integer / int64クエリ内省略可能
10000

応答が開始される項目のオフセット。

booleanクエリ内省略可能
true

オフセットベースのページ割り方式ではなく マーカーベースのページ割り方式を使用するかどうかを指定します。同時に使用できるページ割りの方式は 1つのみです。

この値をtrueに設定すると、APIは、応答の次のページを取得するために、 このエンドポイントにパラメータとして渡すことができる markerフィールドを返します。

stringクエリ内省略可能
managed

指定したタイプのユーザーのみに結果を絞り込みます。

  • allを指定すると、loginまたはnamefilter_termと部分的に一致するすべての種類のユーザーが返されます。ログインがfilter_termと完全に一致した場合は、外部ユーザーのみが返され、その場合に返されるユーザーは、完全に一致したユーザーのみです。
  • managedを指定すると、loginまたはnamefilter_termと部分的に一致するすべての管理対象ユーザーおよびアプリユーザーが返されます。
  • externalを指定すると、loginfilter_termと完全に一致するすべての外部ユーザーが返されます。

次の値のいずれか1つ: all,managed,external

レスポンス

application/jsonUsers

会社内のすべてのユーザーを返します。

予期しないクライアントエラー。

get
会社ユーザーのリストを取得
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -i -X GET "https://api.box.com/2.0/users" \
     -H "Authorization: Bearer <ACCESS_TOKEN>"
Java
Iterable<BoxUser.Info> users = BoxUser.getAllEnterpriseUsers(api, true, null);

// Get marker
String marker = ((BoxResourceIterable<BoxUser.Info>) users).getNextMarker();

レスポンスの例

{
  "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
      }
    }
  ],
  "limit": 1000,
  "offset": 2000,
  "order": [
    {
      "by": "type",
      "direction": "ASC"
    }
  ],
  "total_count": 5000
}