دسته‌ها را مشاهده کنید

کاربران

مدت زمان مطالعه: : 7 دقیقه

از موارد زیر استفاده کنید API روش های درخواست جزئیات در مورد کاربران

get_user #

یک کاربر موجود را برمی گرداند.

GET index.php?/api/v2/get_user/{user_id}

پارامترها #

نام تایپ کنید مورد نیاز توضیحات
user_id عدد صحیح درست است شناسه کاربر

محتوای پاسخ (TestRail Professional) #

{
    "id": 1,
    "email": "john.doe@gurock.io",
    "email_notifications": true,
    "is_active": true,
    "is_admin": false,
    "name": "John Doe",
    "role_id": 3,
    "role": "Tester",
    "group_ids": [1, 2, 3],
    "mfa_required": false
}

محتوای پاسخ (TestRail Enterprise) #

{
    "id": 1,
    "email": "john.doe@gurock.io",
    "email_notifications": true,
    "is_active": true,
    "is_admin": false,
    "name": "John Doe",
    "role_id": 3,
    "role": "Tester",
    "group_ids": [1, 2, 3],
    "mfa_required": false,
    "sso_enabled": true,
    "assigned_projects": [1, 3]
}

فیلدهای زیر در پاسخ گنجانده شده است:

نام تایپ کنید توضیحات
پروژه های اختصاص داده شده آرایه مجموعه ای از شناسه های پروژه هر شناسه پروژه ای است که کاربر به آن اختصاص داده شده است. برای اطلاعات بیشتر به مدیریت سطح پروژه مراجعه کنید – به TestRail Enterprise ۷.۳ یا بالاتر نیاز دارد
ایمیل رشته آدرس ایمیل کاربر همانطور که در TestRail پیکربندی شده است
ایمیل_اعلان ها بولی درست است اگر اعلان‌های ایمیل برای کاربر فعال باشد – به TestRail ۷.۳ یا بالاتر نیاز دارد
شناسه عدد صحیح شناسه منحصر به فرد کاربر
فعال است بولی اگر کاربر فعال باشد درست است و در غیر این صورت نادرست
is_admin بولی درست است اگر کاربر یک سرپرست TestRail باشد – rبه TestRail ۷.۳ یا بالاتر نیاز دارد
group_ids آرایه مجموعه ای از شناسه های گروهی هر شناسه گروهی است که کاربر به آن اختصاص داده شده است – به TestRail ۷.۳ یا بالاتر نیاز دارد
mfa_required بولی درست است اگر نمایه کاربر طوری پیکربندی شده باشد که در هر ورود به MFA نیاز داشته باشد – به TestRail ۷.۳ یا بالاتر نیاز دارد
نام رشته نام کامل کاربر
role_id عدد صحیح شناسه منحصر به فرد نقش اختصاص داده شده به کاربر در سطح جهانی – به TestRail ۶.۴ یا بالاتر نیاز دارد
نقش رشته نام نقشی که کاربر در سطح جهانی اختصاص داده است – به TestRail ۶.۴ یا بالاتر نیاز دارد
sso_enabled بولی درست است اگر نمایه کاربر Single Sign-On را فعال کرده باشد – به TestRail Enterprise ۷.۳ یا بالاتر نیاز دارد

  #

هر کاربر می تواند اطلاعات حساب خود را بازیابی کند. بازیابی اطلاعات برای هر کاربرد دیگری نیاز به دسترسی سرپرست دارد.

کدهای پاسخگویی #

کد وضعیت توضیحات
200 موفقیت آمیز (کاربر به عنوان بخشی از پاسخ بازگردانده می شود)
400 کاربر نامعتبر یا ناشناس
429 فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API)

get_current_user #

  #

این نقطه پایانی به TestRail ۶.۶ یا بالاتر نیاز دارد.

جزئیات کاربر را برای کاربر TestRail که درخواست API را انجام می دهد، برمی گرداند.

GET index.php?/api/v2/get_current_user/{user_id}

پارامترها #

نام تایپ کنید مورد نیاز توضیحات
user_id عدد صحیح درست است شناسه کاربر

محتوای پاسخگویی #

{
    "id": 1,
    "email": "john.doe@gurock.io",
    "is_active": true,
    "name": "John Doe",
    "role_id": 3,
    "role": "Tester"
}

فیلدهای زیر در پاسخ گنجانده شده است:

نام تایپ کنید توضیحات
ایمیل رشته آدرس ایمیل کاربر همانطور که در TestRail پیکربندی شده است
شناسه عدد صحیح شناسه منحصر به فرد کاربر
فعال است بولی اگر کاربر فعال باشد درست است و در غیر این صورت نادرست
نام رشته نام کامل کاربر
role_id عدد صحیح شناسه منحصر به فرد نقش اختصاص داده شده به کاربر در سطح جهانی – به TestRail ۶.۴ یا بالاتر نیاز دارد
نقش رشته نام نقشی که کاربر در سطح جهانی اختصاص داده است – به TestRail ۶.۴ یا بالاتر نیاز دارد

  #

هر کاربر می تواند اطلاعات حساب خود را بازیابی کند. بازیابی اطلاعات برای هر کاربرد دیگری نیاز به دسترسی سرپرست دارد.

کدهای پاسخگویی #

کد وضعیت توضیحات
200 موفقیت آمیز (کاربر به عنوان بخشی از پاسخ بازگردانده می شود)
400 کاربر نامعتبر یا ناشناس
429 فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API)

get_user_by_email #

یک کاربر موجود را با آدرس ایمیل او برمی گرداند.

GET index.php?/api/v2/get_user_by_email&email={email}

پارامترها #

نام تایپ کنید مورد نیاز توضیحات
ایمیل رشته درست است آدرس ایمیل برای دریافت کاربر

این روش از همان قالب پاسخ استفاده می کند get_user.

  #

هر کاربر می تواند اطلاعات حساب خود را بازیابی کند. بازیابی اطلاعات برای هر کاربرد دیگری نیاز به دسترسی سرپرست دارد.

کدهای پاسخگویی #

کد وضعیت توضیحات
200 موفقیت آمیز (کاربر به عنوان بخشی از پاسخ بازگردانده می شود)
400/404 آدرس ایمیل نامعتبر یا ناشناخته
429 فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API)

get_users #

لیستی از کاربران را برمی گرداند.

GET index.php?/api/v2/get_users
GET index.php?/api/v2/get_users/{project_id}

  #

از TestRail ۶.۶، فقط مدیران می توانند از get_users بدون پارامتر project_id استفاده کنند. افراد غیر سرپرست باید از پارامتر project_id استفاده کنند.

پارامترها #

نام تایپ کنید مورد نیاز توضیحات
پروژه_id عدد صحیح درست است شناسه پروژه ای که می خواهید اطلاعات کاربر را برای آن بازیابی کنید. (برای افراد غیر مدیر الزامی است.) – به TestRail ۶.۶ یا بالاتر نیاز دارد

لطفا توجه داشته باشید: #

  • غیر مدیر باید پارامتر project_id را شامل شود.
  • هنگامی که یک project_id حذف می شود، تمام اطلاعات کاربر برگردانده می شود.
  • get_users/{project_id} فقط کاربرانی را با دسترسی صریح به پروژه بازیابی می‌کند و کاربرانی را با دسترسی جهانی فهرست نمی‌کند.

وقتی از پارامتر project_id استفاده می شود: #

  • مقادیر role و role_id برگردانده شده با دسترسی در سطح پروژه کاربر مطابقت دارد.
  • کاربران غیرفعال در پاسخ گنجانده نشده اند.
  • کاربران بدون دسترسی به پروژه شامل پاسخ نمی شوند.

محتوای پاسخگویی #

[
    {
        "id": 1,
        "name": "John Doe",
    },
    {
        "id": 2,
        "name": "Alexis Gonzalez",
    },
]

پاسخ شامل مجموعه ای از کاربران است. هر کاربر در این لیست از همان قالب پیروی می کند get_user.

کدهای پاسخگویی #

کد وضعیت توضیحات
200 موفقیت (کاربران به عنوان بخشی از پاسخ بازگردانده می شوند)
400

project_id نامعتبر است
403

مجوزهای ناکافی
429 فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API)

add_user #

  #

این نقطه پایانی به TestRail ۷.۳ یا بالاتر نیاز دارد.

POST index.php?/api/v2/add_user

درخواست نمونه #

{
    "name": "John Doe",
    "email": "john.doe@gurock.io"
}

فیلدهای زیر در پاسخ گنجانده شده است:

نام تایپ کنید توضیحات
پروژه های اختصاص داده شده آرایه آرایه ای از شناسه های پروژه برای تخصیص به مدیر سطح پروژه. برای اطلاعات بیشتر به مدیریت سطح پروژه مراجعه کنید.
ایمیل رشته آدرس ایمیل کاربر. (الزامی)
ایمیل_اعلان ها بولی نادرست برای غیرفعال کردن اعلان های ایمیل برای کاربر. پیش فرض: درست است.
فعال است بولی اگر کاربر فعال باشد یا نه درست است. پیش فرض: نادرست.
is_admin بولی درست است تا کاربر را به عنوان مدیر TestRail تبدیل کند. پیش فرض: نادرست.
group_ids آرایه آرایه ای از شناسه های گروهی که کاربر را به آن اختصاص می دهد
mfa_required بولی درست است که به احراز هویت چند عاملی برای کاربر نیاز دارد. مقدار پیش‌فرض با تنظیم MFA نمونه مطابقت دارد
نام رشته نام کاربر. (الزامی)
role_id عدد صحیح شناسه نقش جهانی برای تخصیص به کاربر
sso_enabled بولی درست است تا SSO را برای کاربر فعال کند. مقدار پیش‌فرض با تنظیمات SSO نمونه مطابقت دارد

محتوای پاسخگویی #

در صورت موفقیت آمیز بودن، این روش کاربر جدید را با استفاده از همان قالب پاسخ باز می گرداند get_user.

کدهای پاسخگویی #

کد وضعیت توضیحات
200 موفقیت (کاربر ایجاد شد)
400

مقدار فیلد نامعتبر، مانند آدرس ایمیل
403

هیچ مجوزی برای ایجاد کاربر وجود ندارد

update_user #

یک کاربر موجود را به روز می کند.

POST index.php?/api/v2/update_user/:user_id

پارامترها #

نام تایپ کنید مورد نیاز توضیحات
user_id عدد صحیح درست است شناسه کاربر

فیلدهای درخواست #

این نقطه پایانی همان فیلدها را پشتیبانی می کند add_user.

محتوای پاسخگویی #

در صورت موفقیت آمیز بودن، این روش کاربر به روز شده را با استفاده از همان قالب پاسخ باز می گرداند get_user.

کدهای پاسخگویی #

کد وضعیت توضیحات
200 موفقیت آمیز (کاربر به روز شد)
400 مقدار فیلد نامعتبر، مانند آدرس ایمیل
403

اجازه به روز رسانی کاربران وجود ندارد

 

به‌روزرسانی شده در 1405-04-15

احساسات شما چیست؟

  • خوشحال
  • عادی
  • ناراحت

دیدگاهتان را بنویسید