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

get

https://api.box.com/2.0

/users

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

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

関連するガイド

リクエスト

Content-Typeapplication/json

クエリパラメータ

fieldsstring arrayクエリ内省略可能

例id,type,name

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

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

filter_term stringクエリ内省略可能

例john

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

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

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

例1000範囲1000

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

marker stringクエリ内省略可能

例JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

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

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

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

例1000デフォルト0

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

usemarker booleanクエリ内省略可能

例true

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

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

user_type stringクエリ内省略可能

例managed

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

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

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

レスポンス

200application/jsonUsers

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

defaultapplication/jsonクライアントエラー

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

get

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

このドキュメント内で一部のAPIを試せるようになりました。

ログイン

リクエストの例

cURL

curl -X GET https://api.box.com/2.0/users \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'

.NET

BoxCollection<BoxUser> users = await client.UsersManager.GetEnterpriseUsersAsync();

Java

Iterable<BoxUser.Info> users = BoxUser.getAllEnterpriseUsers(api, true, null);

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

Python

users = client.users(user_type='all')
for user in users:
    print('{0} (User ID: {1})'.format(user.name, user.id))

Node

client.enterprise.getUsers({usemarker: true, marker: 'JFUirotE56hfyr56FH123'})
	.then(users => {
		/* users -> {
			total_count: 1,
			entries: 
			[ { type: 'user',
				id: '33333',
				name: 'Example User',
				login: 'user@example.com',
				created_at: '2012-05-03T21:39:11-07:00',
				modified_at: '2012-08-23T14:57:48-07:00',
				language: 'en',
				space_amount: 5368709120,
				space_used: 52947,
				max_upload_size: 104857600,
				status: 'active',
				job_title: '',
				phone: '5555551374',
				address: '10 Cloud Way Los Altos CA',
				avatar_url: 'https://app.box.com/api/avatar/large/deprecated' } ] }
		*/
	});

iOS

client.users.listForEnterprise() {
    switch results {
    case let .success(iterator):
        for i in 1 ... 10 {
            iterator.next { result in
                switch result {
                case let .success(user):
                    print("\(user.name) (ID: \(user.id))")
                case let .failure(error):
                    print(error)
                }
            }
        }
    case let .failure(error):
        print(error)
    }
}