ページを選択

API: ユーザー

API: ユーザー

ユーザーに関する情報を取得するには、次の API メソッドを使用します。

get_user

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

GET index.php?/api/v2/get_user/:user_id
:user_id ユーザーの ID

レスポンスの内容

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

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

名前 タイプ 説明
email string TestRail で設定されているユーザーの電子メールアドレス
id int ユーザーの一意の ID
is_active bool ユーザーがアクティブである場合は true、そうでない場合は false
name string ユーザーのフル ネーム
role_id int ユーザーのグローバルに割り当てられたロールの ID (TestRail 6.4 以降が必要)
role string ユーザーのグローバルに割り当てられたロールの名前 (TestRail 6.4 以降が必要)

注意: すべてのユーザーは自分自身のアカウント情報を取得できます。他のユーザーの情報を取得するには管理者アクセス権が必要です。

レスポンス コード

200 成功。ユーザーがレスポンスの一部として返されます
400 無効または不明なユーザー ID です

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"
}

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

名前 タイプ 説明
email string TestRail で設定されているユーザーの電子メールアドレス
id int ユーザーの一意の ID
is_active bool ユーザーがアクティブである場合は true、そうでない場合は false
name string ユーザーのフル ネーム
role_id int ユーザーのグローバルに割り当てられたロールの ID (TestRail 6.4 以降が必要)
role string ユーザーのグローバルに割り当てられたロールの名前 (TestRail 6.4 以降が必要)

注意: すべてのユーザーは自分自身のアカウント情報を取得できます。他のユーザーの情報を取得するには管理者アクセス権が必要です。

レスポンス コード

200 成功。ユーザーがレスポンスの一部として返されます
400 無効または不明なユーザー ID です

get_user_by_email

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

GET index.php?/api/v2/get_user_by_email&email=:email
:email 取得するユーザーの電子メール アドレス

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

注意: すべてのユーザーは自分自身のアカウント情報を取得できます。他のユーザーの情報を取得するには管理者アクセス権が必要です。

レスポンス コード

200 成功。ユーザーがレスポンスの一部として返されます
400/404 無効または不明な電子メール アドレスです

get_users

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

GET index.php?/api/v2/get_users
:project_id ユーザー情報を取得するプロジェクトの ID (管理者以外の場合に必須。TestRail 6.6 以降が必要)

注意:

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

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

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

レスポンスの内容

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

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

レスポンス コード

200 成功。ユーザーがレスポンスの一部として返されます
400 無効な project_id
403 不適切なパーミッション