---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Cloud Runner TestUserApi -- Com escopo, global

# Cloud Runner TestUserApi -- Com escopo, global {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 6 min. de leitura

Gerencia trabalhos de usuário de teste a serem executados em um executor na nuvem para Automated Test Framework (ATF).
Esta API faz parte da inclusão de script CloudRunnerApi.  
Você pode usar esta API para as seguintes tarefas:

* Inicie o trabalho de teste do usuário.
* Defina o usuário da nuvem.
* Verifique se o usuário especificado é válido.
* Verifique o andamento do trabalho de teste do usuário.
* Cancele o trabalho de teste.
{#cloudrnr-TestUserAPI-scoped__cloudrnr-TestUserAPI-scoped_ul_vwb_wvn_31c}

No escopo global, esta API é executada no namespace sn_atf_tg. Você deve ter o plug-in [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) ativado para usar esta API.  
Consulte também:

* [Cloud Runner TestGenerationApi -- Com escopo, global](https://servicenow-prod.fluidtopics.net/zt~Oln47K8guNs44Pk~gIw#cloudrnr-TestGenerationAPI-scoped "Gerencia a geração de trabalho de teste a ser executada em um executor na nuvem para Automated Test Framework (ATF). Esta API faz parte da inclusão de script CloudRunnerApi.")
* [Cloud Runner TestRunnerApi -- Com escopo, global](https://servicenow-prod.fluidtopics.net/uyPKSrnO~W6olBPMnXNFtQ#cloudrnr-TestRunnerAPI-scoped "Gerencia testes a serem executados em um executor na nuvem para Automated Test Framework (ATF). Esta API faz parte da inclusão de script CloudRunnerApi.")
* [REST API do executor de teste do Cloud Runner](https://servicenow-prod.fluidtopics.net/2nyvSJjenLiR3rbZnj~rNg#cloudrunner-testrunner-api "Gerencia testes a serem executados em um executor na nuvem para Automated Test Framework (ATF).")
{#cloudrnr-TestUserAPI-scoped__ul_gd4_zsn_31c}

## TestUserApi -- cancelJob(cadeia de caracteres snboqId) {#ariaid-title2}

Define como concluído o status do trabalho do usuário de teste na tabela Fila de Orquestração do Navegador \[sn_atf_tg_sn_boq\].
{#cr-TestUserAPI-cancelJob_S__table_epx_lv4_g1c__entry__3}{#cr-TestUserAPI-cancelJob_S__cr-snboqId-ph-desc}

| Nome | Tipo | Descrição |
|-|-|-|
| snboqId | Cadeia de caracteres | Obrigatório. O sys_id do registro BOQ na tabela Fila de Orquestração do Navegador \[sn_atf_tg_sn_boq\]. |
[Tabela 1. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| nulo | Nulo se for bem-sucedido, mensagem de erro caso contrário. |
| Erro | Se malsucedido, mensagens de erro possíveis: * Nenhum ID de BOQ passado -- o objeto JSON fornecido não tem uma entrada de ID de BOQ. Verifique se o objeto JSON está estruturado como `{snboqId: "`\<sys_id\> "} . * sys_id de BOQ inválido passado - o ID fornecido deve ser para um registro de BOQ na tabela Fila de Orquestração do navegador \[sn_atf_tg_sn_boq\]. {#cr-TestUserAPI-cancelJob_S__ul_wqr_slb_j1c} |
[Tabela 2. Retorna]

{#cr-TestUserAPI-cancelJob_S__table_fpx_lv4_g1c}  
O exemplo a seguir mostra como iniciar um usuário de teste para o usuário administrador, obter o andamento e cancelar o usuário de teste. Depois de confirmar o usuário bloqueado como um usuário da nuvem válido, o código define o usuário da nuvem como um administrador ITIL. No escopo global, use o namespace 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"});

Saída:

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

## TestUserApi -- isValidCloudUser(cadeia de caracteres nome de usuário) {#ariaid-title3}

Verifica se um usuário fornecido é um usuário de nuvem válido.
{#cr-TestUserAPI-isValidCloudUser_S__table_epx_lv4_g1c__entry__3}{#cr-TestUserAPI-isValidCloudUser_S__cr-userNm-ph-desc}

| Nome | Tipo | Descrição |
|-|-|-|
| nome do usuário | Objeto | Obrigatório. ID de um usuário válido listado na tabela Usuários \[sys_user\]. Este valor é fornecido como uma cadeia de caracteres em um objeto JSON. Por exemplo, `{username: "abel.tuter"}`. |
[Tabela 3. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Booliano | Sinalizador que indica se o usuário fornecido é um usuário de nuvem válido. Valores válidos: * verdadeiro: o usuário fornecido é um usuário de nuvem válido. * falso: o usuário fornecido é inválido por um ou mais dos seguintes motivos: * O usuário não foi encontrado. * O usuário está inativo. * O usuário está bloqueado. * O usuário precisa de uma redefinição de senha. * O usuário não tem uma função de administrador. * O usuário tem acesso somente leitura. * O usuário tem acesso somente a serviços da Web. {#cr-TestUserAPI-isValidCloudUser_S__ul_gzz_dcg_m1c} {#cr-TestUserAPI-isValidCloudUser_S__ul_ofc_wzf_m1c} |
[Tabela 4. Retorna]

{#cr-TestUserAPI-isValidCloudUser_S__table_fpx_lv4_g1c}  
O exemplo a seguir mostra como iniciar um usuário de teste para o usuário administrador, obter o andamento e cancelar o usuário de teste. Depois de confirmar o usuário bloqueado como um usuário da nuvem válido, o código define o usuário da nuvem como um administrador ITIL. No escopo global, use o namespace 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"});

Saída:

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

## TestUserApi -- andamento (cadeia de caracteres snboqId) {#ariaid-title4}

Fornece o status de cada teste de usuário para um registro de Fila de Orquestração de Navegador (BOQ) fornecido.
{#cr-TestUserAPI-progress_S__table_epx_lv4_g1c__entry__3}{#cr-TestUserAPI-progress_S__cr-snboqId-ph-desc}

| Nome | Tipo | Descrição |
|-|-|-|
| snboqId | Cadeia de caracteres | Obrigatório. O sys_id do registro BOQ na tabela Fila de Orquestração do Navegador \[sn_atf_tg_sn_boq\]. |
[Tabela 5. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Objeto | Objeto JSON que indica o andamento do teste. { "progress": Number, "state": "String" } |
| Objeto.andamento | Indica a porcentagem de andamento do teste concluída. Tipo: número |
| Objeto.estado | Estado do registro de BOQ. Valores possíveis: * Pendente - a atividade de teste solicitada foi criada e está aguardando a execução.{#cr-TestUserAPI-progress_S__cr-prog-state-li-pending} {#cr-TestUserAPI-progress_S__cr-prog-state-li-pending} * Processamento -- A instância está verificando registros para garantir que os rastreadores de execução sejam marcados para executor na nuvem antes que a solicitação seja enviada para a infraestrutura em nuvem. * Navegadores solicitados -- uma solicitação foi enviada à infraestrutura em nuvem para iniciar navegadores para geração de teste ou execução de teste.{#cr-TestUserAPI-progress_S__cr-prog-state-li-brsreq} {#cr-TestUserAPI-progress_S__cr-prog-state-li-brsreq} * Em execução -- Os navegadores de infraestrutura em nuvem localizam e executam testes pendentes. * Concluído -- A tarefa de teste está concluída.{#cr-TestUserAPI-progress_S__cr-prog-state-li-complete} {#cr-TestUserAPI-progress_S__cr-prog-state-li-complete} * Estado de falha -- A tarefa de teste falhou.{#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} Tipo: cadeia de caracteres |
| Erro | Se malsucedido, mensagens de erro possíveis: * Nenhum ID de BOQ passado -- o objeto JSON fornecido não tem uma entrada de ID de BOQ. Verifique se o objeto JSON está estruturado como `{snboqId: "`\<sys_id\> "} . * sys_id de BOQ inválido passado - o ID fornecido deve ser para um registro de BOQ na tabela Fila de Orquestração do navegador \[sn_atf_tg_sn_boq\]. {#cr-TestUserAPI-progress_S__ul_wqr_slb_j1c} |
[Tabela 6. Retorna]

{#cr-TestUserAPI-progress_S__table_fpx_lv4_g1c}  
O exemplo a seguir mostra como iniciar um usuário de teste para o usuário administrador, obter o andamento e cancelar o usuário de teste. Depois de confirmar o usuário bloqueado como um usuário da nuvem válido, o código define o usuário da nuvem como um administrador ITIL. No escopo global, use o namespace 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"});

Saída:

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

## TestUserApi -- selectCloudUser(cadeia de caracteres nome de usuário) {#ariaid-title5}

Inicia um trabalho de usuário de teste de ponta a ponta no executor na nuvem. Se o usuário conseguir fazer login corretamente com a função de administrador, a propriedade do usuário da nuvem será definida como este usuário para simulações futuras e gerações de teste na infraestrutura do executor na nuvem.
{#cr-TestUserAPI-selectCloudUser_S__table_epx_lv4_g1c__entry__3}{#cr-TestUserAPI-selectCloudUser_S__cr-userNm-ph-desc}

| Nome | Tipo | Descrição |
|-|-|-|
| nome do usuário | Objeto | Obrigatório. ID de um usuário válido listado na tabela Usuários \[sys_user\]. Este valor é fornecido como uma cadeia de caracteres em um objeto JSON. Por exemplo, `{username: "abel.tuter"}`. |
[Tabela 7. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Nulo | Nulo se for bem-sucedido. Caso contrário, mensagem de erro. Não é possível definir o usuário da nuvem como usuário da nuvem inválido -- Este erro indica que o usuário fornecido é inválido por um ou mais dos seguintes motivos: * O usuário não foi encontrado. * O usuário está inativo. * O usuário está bloqueado. * O usuário precisa de uma redefinição de senha. * O usuário não tem uma função de administrador. * O usuário tem acesso somente leitura. * O usuário tem acesso somente a serviços da Web. {#cr-TestUserAPI-selectCloudUser_S__ul_gzz_dcg_m1c} |
[Tabela 8. Retorna]

{#cr-TestUserAPI-selectCloudUser_S__table_fpx_lv4_g1c}  
O exemplo a seguir mostra como iniciar um usuário de teste para o usuário administrador, obter o andamento e cancelar o usuário de teste. Depois de confirmar o usuário bloqueado como um usuário da nuvem válido, o código define o usuário da nuvem como um administrador ITIL. No escopo global, use o namespace 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"});

Saída:

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

## TestUserApi -- startJob(cadeia de caracteres nome de usuário) {#ariaid-title6}

Inicia um trabalho de usuário de teste de ponta a ponta no executor na nuvem.
{#cr-TestUserAPI-startJob_S__table_epx_lv4_g1c__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| nome do usuário | Cadeia de caracteres | Obrigatório. Nome de usuário de sys_user para testar a infraestrutura de ponta a ponta do executor na nuvem. |
[Tabela 9. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | O sys_id do registro BOQ na tabela Fila de Orquestração do Navegador \[sn_atf_tg_sn_boq\]. |
[Tabela 10. Retorna]

{#cr-TestUserAPI-startJob_S__table_fpx_lv4_g1c}  
O exemplo a seguir mostra como iniciar um usuário de teste para o usuário administrador, obter o andamento e cancelar o usuário de teste. Depois de confirmar o usuário bloqueado como um usuário da nuvem válido, o código define o usuário da nuvem como um administrador ITIL. No escopo global, use o namespace 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"});

Saída:

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