پرش به مطلب اصلی

فهرست کاربران و گره‌ی هر کدام

GET 
/api/v1/admin/assignments

فهرست صفحه‌بندی‌شده‌ی کاربران و گره‌ای که هر کدام به آن سپرده شده را برمی‌گرداند. فقط سپردن‌های جاری (آزادنشده) در فهرست هستند.

این درخواست مستقیم به سرور سراسری (اصلی) فرستاده می‌شود، یعنی https://nb.<base-domain>، نه به نشانی گره.

دسترسی: فقط مدیر سامانه. توکن باید توکن کاربر باشد (نه توکن client-credentials) و نقش admin داشته باشد. بدون توکن پاسخ 401 و برای کاربر بدون نقش admin پاسخ 403 است.

پارامترها: node (اختیاری) نام گره است، بدون حساسیت به حروف بزرگ و کوچک؛ نام ناشناخته صفحه‌ی خالی با total: 0 برمی‌گرداند، نه 404. q (اختیاری) بخشی از ایمیل است، بدون حساسیت به حروف؛ بیش از ۲۵۶ نویسه پاسخ 400 با code: INVALID_QUERY می‌دهد. page شماره‌ی صفحه است و از 1 شروع می‌شود (پیش‌فرض 1). pageSize پیش‌فرض ۵۰ و بیشینه ۲۰۰ است؛ مقدار بزرگ‌تر کوتاه نمی‌شود و پاسخ 400 با code: INVALID_PAGING برمی‌گرداند.

پاسخ: { "node", "nodeUrl", "total", "page", "pageSize", "items": [ { "email", "node", "nodeUrl", "assignedOn" } ] }، مرتب بر اساس ایمیل. total تعداد کل ردیف‌های مطابق است.

نکته: این مسیر حتی وقتی مجوز معتبر نیست یا منقضی شده پاسخ می‌دهد.

درخواست​

پاسخ‌ها​

OK