API: ユーザー

get_user

既存のユーザーを返します。

GET index.php?/api/v2/get_user/:user_id

レスポンスの内容

{
    "email": "alexis@example.com",
    "id": 1,
    "is_active": true,
    "name": "Alexis Gonzalez",
    "role_id": "1",
    "role": "Lead"
}

レスポンスには次のフィールドが含まれています。

レスポンス コード

get_current_user

API リクエストを行っている TestRail ユーザーの詳細を返します。

GET index.php?/api/v2/get_current_user/:user_id

レスポンスの内容

{
    "email": "alexis@example.com",
    "id": 1,
    "is_active": true,
    "name": "Alexis Gonzalez",
    "role_id": "1",
    "role": "Lead"
}

レスポンスには次のフィールドが含まれています。

レスポンス コード

get_user_by_email

電子メールアドレスで検索した既存のユーザーを返します。

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

このメソッドは get_user と同じレスポンス フォーマットを使用します。

レスポンス コード

get_users

ユーザーのリストを返します。

GET index.php?/api/v2/get_users

注意:

• 管理者以外は project_id パラメーターを指定する必要があります。
• project_id が省略された場合、すべての情報が返されます。

project_id パラメーターが指定された場合

• ユーザーのプロジェクトレベルのアクセス権に応じた role および role_id の値が返されます。
• アクティブではないユーザーはレスポンスに含まれません。
• プロジェクトへのアクセス権がないユーザーはレスポンスに含まれません。

レスポンスの内容

[
    { "id": 1, "name": "Alexis Gonzalez", .. },
    { "id": 2, "name": "Ciaran Davenport", .. },
    ..
]

レスポンスにはユーザーの配列が含まれます。リスト内の各ユーザーの形式は、get_user と同じです。

レスポンス コード