---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# クラウドランナー TestUserApi -- スコープ指定、グローバル

# クラウドランナー TestUserApi -- スコープ指定、グローバル {#ariaid-title1}

* リリースバージョン: Xanadu
* 
* 更新日 2024年08月01日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：12分

自動テストフレームワーク (ATF) のクラウドランナーで実行されるテストユーザージョブを管理します。
この API は、CloudRunnerApi スクリプトインクルードの一部です。  
この API は、次のタスクに使用できます。

* ユーザーテストジョブを開始します。
* クラウドユーザーを設定します。
* 指定されたユーザーが有効かどうかを確認します。
* ユーザーテストジョブの進捗状況を確認します。
* テストジョブをキャンセルします。
{#cloudrnr-TestUserAPI-scoped__cloudrnr-TestUserAPI-scoped_ul_vwb_wvn_31c}

グローバルスコープでは、この API は sn_atf_tg 名前空間内で実行されます。この API を使用するには、 [ATF Test Generator and Cloud Runner](https://www.servicenow.com/docs/access?context=atf-tg-cr-intro&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US) (sn_atf_tg) プラグインを有効にする必要があります。  
関連項目：

* [クラウドランナー TestGenerationApi -- スコープ対象、グローバル](https://servicenow-prod.fluidtopics.net/JyiNHjSgugC7jAMWpARmTw#cloudrnr-TestGenerationAPI-scoped "自動テストフレームワーク (ATF) のクラウドランナーで実行するテストジョブの生成を管理します。 この API は、CloudRunnerApi スクリプトインクルードの一部です。")
* [クラウドランナー TestRunnerApi -- スコープ対象、グローバル](https://servicenow-prod.fluidtopics.net/GKh0rg8wLZXF6vQ_LjLzSw#cloudrnr-TestRunnerAPI-scoped "自動テストフレームワーク (ATF) のクラウドランナーで実行するテストを管理します。 この API は、CloudRunnerApi スクリプトインクルードの一部です。")
* [クラウドランナーテストランナー REST API](https://servicenow-prod.fluidtopics.net/RILdTawwwSS8tyGsXGJojA#cloudrunner-testrunner-api "自動テストフレームワーク (ATF) のクラウドランナーで実行するテストを管理します。")
{#cloudrnr-TestUserAPI-scoped__ul_gd4_zsn_31c}

## TestUserApi -- cancelJob(文字列 snboqId) {#ariaid-title2}

ブラウザーオーケストレーションキュー \[sn_atf_tg_sn_boq\] テーブルのテストユーザージョブのステータスを完了に設定します。
{#cr-TestUserAPI-cancelJob_S__table_epx_lv4_g1c__entry__3}{#cr-TestUserAPI-cancelJob_S__cr-snboqId-ph-desc}

| 名前 | タイプ | 説明 |
|-|-|-|
| snboqId | 文字列 | 必須。ブラウザーオーケストレーションキュー \[sn_atf_tg_sn_boq\] テーブル内の BOQ レコードのsys_id。 |
[表 : 1. パラメーター]

{#cr-TestUserAPI-cancelJob_S__table_epx_lv4_g1c} {#cr-TestUserAPI-cancelJob_S__table_fpx_lv4_g1c__entry__2}

| タイプ | 説明 |
|-|-|
| null | 成功した場合は Null、それ以外の場合はエラーメッセージ。 |
| エラー | 失敗した場合、考えられるエラーメッセージ: * BOQ ID が渡されない -- 指定された JSON オブジェクトに BOQ ID エントリがありません。JSON オブジェクトが `{snboqId: "<sys_id>"}` として構造化されていることを確認します。 * 無効な BOQ sys_idが渡されました -- 指定する ID は、ブラウザオーケストレーションキュー \[sn_atf_tg_sn_boq\] テーブルの BOQ レコード用である必要があります。 {#cr-TestUserAPI-cancelJob_S__ul_wqr_slb_j1c} |
[表 : 2. 返される内容]

{#cr-TestUserAPI-cancelJob_S__table_fpx_lv4_g1c}  
次の例は、アドミンユーザーのテストユーザーを開始し、進行状況を取得して、テストユーザーをキャンセルする方法を示しています。ロックアウトされたユーザーが有効なクラウドユーザーであることを確認した後、コードはクラウドユーザーを ITIL アドミニストレーターとして設定します。グローバルスコープでは、sn_atf_tg 名前空間を使用します。

    var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"});

    gs.info(JSON.stringify(CloudRunnerAPI.TestUserAPI.progress({snboqId: snboqId})));

    CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId});

    gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: <name of the user who has been locked out>}));

    CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"});

出力:

    {progress: 64, state: running}
    User is missing the following criteria: 
    	User is locked out
    False

## TestUserApi -- isValidCloudUser(文字列ユーザー名) {#ariaid-title3}

指定されたユーザーが有効なクラウドユーザーであるかどうかを確認します。
{#cr-TestUserAPI-isValidCloudUser_S__table_epx_lv4_g1c__entry__3}{#cr-TestUserAPI-isValidCloudUser_S__cr-userNm-ph-desc}

| 名前 | タイプ | 説明 |
|-|-|-|
| username | オブジェクト | 必須。ユーザー \[sys_user\] テーブルにリストされている有効なユーザーのユーザー ID。この値は、JSON オブジェクトの文字列として提供されます。たとえば、 `{username: "abel.tuter"}` です。 |
[表 : 3. パラメーター]

{#cr-TestUserAPI-isValidCloudUser_S__table_epx_lv4_g1c} {#cr-TestUserAPI-isValidCloudUser_S__table_fpx_lv4_g1c__entry__2}

| タイプ | 説明 |
|-|-|
| ブーリアン | 指定されたユーザーが有効なクラウドユーザーであるかどうかを示すフラグ。 有効な値： * true:指定されたユーザーは有効なクラウドユーザーです。 * false:指定されたユーザーは、次の 1 つ以上の理由で無効です。 * ユーザーが見つかりませんでした。 * ユーザーは非アクティブです。 * ユーザーはロックアウトされています。 * ユーザーはパスワードリセットを必要としている。 * ユーザーに admin ロールがない。 * ユーザーには読み取り専用アクセス権があります。 * ユーザーは Web サービスにのみアクセスできます。 {#cr-TestUserAPI-isValidCloudUser_S__ul_gzz_dcg_m1c} {#cr-TestUserAPI-isValidCloudUser_S__ul_ofc_wzf_m1c} |
[表 : 4. 返される内容]

{#cr-TestUserAPI-isValidCloudUser_S__table_fpx_lv4_g1c}  
次の例は、アドミンユーザーのテストユーザーを開始し、進行状況を取得して、テストユーザーをキャンセルする方法を示しています。ロックアウトされたユーザーが有効なクラウドユーザーであることを確認した後、コードはクラウドユーザーを ITIL アドミニストレーターとして設定します。グローバルスコープでは、sn_atf_tg 名前空間を使用します。

    var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"});

    gs.info(JSON.stringify(CloudRunnerAPI.TestUserAPI.progress({snboqId: snboqId})));

    CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId});

    gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: <name of the user who has been locked out>}));

    CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"});

出力:

    {progress: 64, state: running}
    User is missing the following criteria: 
    	User is locked out
    False

## TestUserApi -- progress(文字列 snboqId) {#ariaid-title4}

指定されたブラウザオーケストレーションキュー (BOQ) レコードの各ユーザーテストのステータスを提供します。
{#cr-TestUserAPI-progress_S__table_epx_lv4_g1c__entry__3}{#cr-TestUserAPI-progress_S__cr-snboqId-ph-desc}

| 名前 | タイプ | 説明 |
|-|-|-|
| snboqId | 文字列 | 必須。ブラウザーオーケストレーションキュー \[sn_atf_tg_sn_boq\] テーブル内の BOQ レコードのsys_id。 |
[表 : 5. パラメーター]

{#cr-TestUserAPI-progress_S__table_epx_lv4_g1c} {#cr-TestUserAPI-progress_S__table_fpx_lv4_g1c__entry__2}{#cr-TestUserAPI-progress_S__cr-prog-state-ph-desc}

| タイプ | 説明 |
|-|-|
| オブジェクト | テストの進行状況を示す JSON オブジェクト。 { "progress": Number, "state": "String" } |
| Object.progress | テストの進行状況完了率を示します。 タイプ：数値 |
| Object.state | BOQ レコードのステータス。 可能な値： * 保留中 -- 要求されたテストアクティビティが作成され、実行を待機しています。{#cr-TestUserAPI-progress_S__cr-prog-state-li-pending} {#cr-TestUserAPI-progress_S__cr-prog-state-li-pending} * 処理中:インスタンスはレコードをスキャンして、リクエストがクラウドインフラストラクチャに送信される前に、実行トラッカーが Cloud Runner 用にマークされていることを確認します。 * 要求されたブラウザー -- テスト生成またはテスト実行のためにブラウザーを起動する要求がクラウドインフラストラクチャに送信されました。{#cr-TestUserAPI-progress_S__cr-prog-state-li-brsreq} {#cr-TestUserAPI-progress_S__cr-prog-state-li-brsreq} * 実行中 -- クラウドインフラストラクチャのブラウザは、保留中のテストを検出して実行します。 * 完了 -- テストタスクが完了しました。{#cr-TestUserAPI-progress_S__cr-prog-state-li-complete} {#cr-TestUserAPI-progress_S__cr-prog-state-li-complete} * \[Failed (失敗)\] ステータス -- テストタスクが失敗しました。{#cr-TestUserAPI-progress_S__cr-prog-state-li-failed} {#cr-TestUserAPI-progress_S__cr-prog-state-li-failed} {#cr-TestUserAPI-progress_S__ul_rvl_vsg_l1c} タイプ：文字列 |
| エラー | 失敗した場合、考えられるエラーメッセージ: * BOQ ID が渡されない -- 指定された JSON オブジェクトに BOQ ID エントリがありません。JSON オブジェクトが `{snboqId: "<sys_id>"}` として構造化されていることを確認します。 * 無効な BOQ sys_idが渡されました -- 指定する ID は、ブラウザオーケストレーションキュー \[sn_atf_tg_sn_boq\] テーブルの BOQ レコード用である必要があります。 {#cr-TestUserAPI-progress_S__ul_wqr_slb_j1c} |
[表 : 6. 返される内容]

{#cr-TestUserAPI-progress_S__table_fpx_lv4_g1c}  
次の例は、アドミンユーザーのテストユーザーを開始し、進行状況を取得して、テストユーザーをキャンセルする方法を示しています。ロックアウトされたユーザーが有効なクラウドユーザーであることを確認した後、コードはクラウドユーザーを ITIL アドミニストレーターとして設定します。グローバルスコープでは、sn_atf_tg 名前空間を使用します。

    var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"});

    gs.info(JSON.stringify(CloudRunnerAPI.TestUserAPI.progress({snboqId: snboqId})));

    CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId});

    gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: <name of the user who has been locked out>}));

    CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"});

出力:

    {progress: 64, state: running}
    User is missing the following criteria: 
    	User is locked out
    False

## TestUserApi -- selectCloudUser(文字列ユーザー名) {#ariaid-title5}

Cloud Runner でエンドツーエンドのテストユーザージョブを開始します。ユーザーが admin ロールで正しくログインできる場合、クラウドランナーインフラストラクチャでの今後のテスト実行とテスト生成のために、クラウドユーザープロパティがこのユーザーとして設定されます。
{#cr-TestUserAPI-selectCloudUser_S__table_epx_lv4_g1c__entry__3}{#cr-TestUserAPI-selectCloudUser_S__cr-userNm-ph-desc}

| 名前 | タイプ | 説明 |
|-|-|-|
| username | オブジェクト | 必須。ユーザー \[sys_user\] テーブルにリストされている有効なユーザーのユーザー ID。この値は、JSON オブジェクトの文字列として提供されます。たとえば、 `{username: "abel.tuter"}` です。 |
[表 : 7. パラメーター]

{#cr-TestUserAPI-selectCloudUser_S__table_epx_lv4_g1c} {#cr-TestUserAPI-selectCloudUser_S__table_fpx_lv4_g1c__entry__2}

| タイプ | 説明 |
|-|-|
| Null | 成功した場合は Null。それ以外の場合はエラーメッセージ。 クラウドユーザーが無効であるため、クラウドユーザーを設定できません - このエラーは、指定されたユーザーが次の 1 つ以上の理由で無効であることを示します。 * ユーザーが見つかりませんでした。 * ユーザーは非アクティブです。 * ユーザーはロックアウトされています。 * ユーザーはパスワードリセットを必要としている。 * ユーザーに admin ロールがない。 * ユーザーには読み取り専用アクセス権があります。 * ユーザーは Web サービスにのみアクセスできます。 {#cr-TestUserAPI-selectCloudUser_S__ul_gzz_dcg_m1c} |
[表 : 8. 返される内容]

{#cr-TestUserAPI-selectCloudUser_S__table_fpx_lv4_g1c}  
次の例は、アドミンユーザーのテストユーザーを開始し、進行状況を取得して、テストユーザーをキャンセルする方法を示しています。ロックアウトされたユーザーが有効なクラウドユーザーであることを確認した後、コードはクラウドユーザーを ITIL アドミニストレーターとして設定します。グローバルスコープでは、sn_atf_tg 名前空間を使用します。

    var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"});

    gs.info(JSON.stringify(CloudRunnerAPI.TestUserAPI.progress({snboqId: snboqId})));

    CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId});

    gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: <name of the user who has been locked out>}));

    CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"});

出力:

    {progress: 64, state: running}
    User is missing the following criteria: 
    	User is locked out
    False

## TestUserApi -- startJob (文字列ユーザー名) {#ariaid-title6}

クラウドランナーでエンドツーエンドのテストユーザージョブを開始します。
{#cr-TestUserAPI-startJob_S__table_epx_lv4_g1c__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| username | 文字列 | 必須。Cloud Runner のエンドツーエンドインフラストラクチャをテストするsys_userのユーザー名。 |
[表 : 9. パラメーター]

{#cr-TestUserAPI-startJob_S__table_epx_lv4_g1c} {#cr-TestUserAPI-startJob_S__table_fpx_lv4_g1c__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | ブラウザーオーケストレーションキュー \[sn_atf_tg_sn_boq\] テーブル内の BOQ レコードのsys_id。 |
[表 : 10. 返される内容]

{#cr-TestUserAPI-startJob_S__table_fpx_lv4_g1c}  
次の例は、アドミンユーザーのテストユーザーを開始し、進行状況を取得して、テストユーザーをキャンセルする方法を示しています。ロックアウトされたユーザーが有効なクラウドユーザーであることを確認した後、コードはクラウドユーザーを ITIL アドミニストレーターとして設定します。グローバルスコープでは、sn_atf_tg 名前空間を使用します。

    var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"});

    gs.info(JSON.stringify(CloudRunnerAPI.TestUserAPI.progress({snboqId: snboqId})));

    CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId});

    gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: <name of the user who has been locked out>}));

    CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"});

出力:

    {progress: 64, state: running}
    User is missing the following criteria: 
    	User is locked out
    False