ユーザー

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

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

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

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

レスポンス コード

get_current_user

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

パラメーター

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

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

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

パラメーター

• • 管理者以外は project_id パラメーターを指定する必要があります。
  • project_id が省略された場合、すべての情報が返されます。
  • get_users/{project_id} は、明示的にプロジェクトにアクセス権があるユーザーだけを取得し、グローバル アクセス権を持つユーザーは含めません。

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

レスポンスの内容

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

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

レスポンス コード

add_user

TestRail 7.3 以降が必要です。

POST index.php?/api/v2/add_user

リクエストの例

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

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

レスポンスの内容

レスポンス コード

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

パラメーター

リクエスト フィールド

エンドポイントは add_user と同じフィールドをサポートしています。

レスポンスの内容

成功した場合、このメソッドは get_user と同じレスポンス形式を使用して更新されたユーザーを返します。

レスポンス コード