会社ユーザーのリストを取得
会社の全ユーザーのリストを、各ユーザーのuser_id、public_name、loginとともに返します。
会社全体のユーザーを参照するには、アプリケーションと認証済みユーザーに適切な権限が付与されている必要があります。
リクエスト
クエリパラメータ
my-user-1234指定したexternal_app_user_id値を持つApp Userに結果を絞り込みます。
アプリユーザーの作成時に、external_app_user_id値を設定できます。その後、この値をこのエンドポイントで使用すると、そのexternal_app_user_id値に一致するすべてのユーザーが見つかります。
id,type,nameレスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。
johnnameまたはloginが検索語で始まるユーザーのみに結果を絞り込みます。
外部で管理されているユーザーを検索するには、ユーザー名またはログインが検索語と完全に一致している必要があります。 同時に返されるユーザーは1人のみです。
10001000返す項目の1ページあたりの最大数。
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。
これを使用するには、usemarkerをtrueに設定する必要があります。
10000レスポンスが開始される項目のオフセット。
オフセットパラメータ値が10,000を超えているクエリは拒否され、400レスポンスが返されます。
trueオフセットベースのページ割り方式ではなくマーカーベースのページ割り方式を使用するかどうかを指定します。同時に使用できるページ割りの方式は1つのみです。
この値をtrueに設定すると、APIは、レスポンスの次のページを取得するために、このエンドポイントにパラメータとして渡すことができるmarkerフィールドを返します。
managed指定したタイプのユーザーのみに結果を絞り込みます。
allを指定すると、loginまたはnameがfilter_termと部分的に一致するすべての種類のユーザーが返されます。ログインがfilter_termと完全に一致した場合は、外部ユーザーのみが返され、その場合に返されるユーザーは、完全に一致したユーザーのみです。managedを指定すると、loginまたはnameがfilter_termと部分的に一致するすべての管理対象ユーザーおよびApp Userが返されます。externalを指定すると、loginがfilter_termと完全に一致するすべての外部ユーザーが返されます。
次の値のいずれか1つ: all,managed,external
リクエストの例
curl -i -X GET "https://api.box.com/2.0/users" \
-H "authorization: Bearer <ACCESS_TOKEN>"await client.users.getUsers();client.users.get_users()await client.Users.GetUsersAsync();Iterable<BoxUser.Info> users = BoxUser.getAllEnterpriseUsers(api, true, null);
// Get marker
String marker = ((BoxResourceIterable<BoxUser.Info>) users).getNextMarker();users = client.users(user_type='all')
for user in users:
print(f'{user.name} (User ID: {user.id})')BoxCollection<BoxUser> users = await client.UsersManager.GetEnterpriseUsersAsync();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' } ] }
*/
});let iterator = client.users.listForEnterprise()
iterator.next { result in
switch results {
case let .success(page):
for user in page.entries {
print("\(user.name) (ID: \(user.id))")
}
case let .failure(error):
print(error)
}
}レスポンスの例
{
"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
},
"role": "admin",
"tracking_codes": [
{
"type": "tracking_code",
"name": "department",
"value": "Sales"
}
],
"can_see_managed_users": true,
"is_sync_enabled": true,
"is_external_collab_restricted": true,
"is_exempt_from_device_limits": true,
"is_exempt_from_login_verification": true,
"enterprise": {
"id": "11446498",
"type": "enterprise",
"name": "Acme Inc."
},
"my_tags": [
"important"
],
"hostname": "https://example.app.box.com/",
"is_platform_access_only": true,
"external_app_user_id": "my-user-1234"
}
],
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
"offset": 2000,
"order": [
{
"by": "type",
"direction": "ASC"
}
],
"prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
"total_count": 5000
}