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


---

# PersonalAuthAPI - com escopo

# PersonalAuthAPI - com escopo {#ariaid-title1}

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

A PersonalAuthAPI fornece métodos que permitem gerenciar tokens de acesso/atualização para credenciais de autenticação pessoal.

Para acessar esta API, o plug-in Autenticação pessoal (com.snc.sn_ihub_personal_auth) deve ser ativado. Esta API é executada no namespace `sn_cc`.

Antes de acessar esta API, a autenticação pessoal deve ser configurada em sua instância. Para obter informações adicionais, confira [Create a Connection \& Credential alias](https://www.servicenow.com/docs/access?context=connection-alias&version=xanadu&pubname=xanadu-platform-security&ft:locale=en-US).

## PersonalAuthAPI - PersonalAuthAPI() {#ariaid-title2}

Instancia um novo objeto PersonalAuthAPI.
{#PerAuth-PersonalAuthAPI__table_t5w_235_lbc__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum(a) |   |   |
[Tabela 1. Parâmetros]

{#PerAuth-PersonalAuthAPI__table_t5w_235_lbc}  
O exemplo de código a seguir mostra como instanciar um objeto PersonalAuthAPI.

    var personalAuthAPI = new sn_cc.PersonalAuthAPI();

## PersonalAuthAPI - getInitiatorURL(cadeia de caracteres aliasId) {#ariaid-title3}

Retorna o URL do iniciador do OAuth para a credencial de autenticação pessoal associada a um alias especificado.
{#PerAuth-getInitiatorURL_S__table_fhk_4bl_3bc__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| aliasId | Cadeia de caracteres | Sys_id do alias de conexão ou credencial cujo URL do iniciador do OAuth você deseja recuperar. Localizado na tabela Aliases de conexão e credencial \[sys_alias\]. |
[Tabela 2. Parâmetros]

{#PerAuth-getInitiatorURL_S__table_fhk_4bl_3bc} {#PerAuth-getInitiatorURL_S__table_ghk_4bl_3bc__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | URL do iniciador do OAuth para a credencial de autenticação pessoal associada ao alias especificado. Se a credencial de autenticação pessoal não existir para o alias especificado, o método retornará uma cadeia de caracteres vazia. |
[Tabela 3. Retorna]

{#PerAuth-getInitiatorURL_S__table_ghk_4bl_3bc}  
O exemplo de código a seguir mostra como chamar este método.

    var aliasId = "e41b9dd1532102104c4bddeeff7b1250";
    var personalAuthAPI = new sn_cc.PersonalAuthAPI();
    var result = personalAuthAPI.getInitiatorURL(aliasId);
    gs.info(result);

Saída:

    /oauth_initiator.do?oauth_requestor_context=oauth_2_0_credentials&oauth_requestor=d84b5115532102104c4bddeeff7b12f2&oauth_provider_profile=d84b5115532102104c4bddeeff7b12ec&response_type=code&personal=true 

## PersonalAuthAPI - isTokenValid(cadeia de caracteres aliasId) {#ariaid-title4}

Verifica se existe um token de acesso/atualização válido para a credencial de autorização pessoal associada a um alias especificado.
{#PerAuth-isTokenValid_S__table_npq_pk2_3bc__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| aliasId | Cadeia de caracteres | Sys_id do alias de conexão ou credencial para verificar a credencial de autorização pessoal associada. Localizado na tabela Aliases de conexão e credencial \[sys_alias\]. |
[Tabela 4. Parâmetros]

{#PerAuth-isTokenValid_S__table_npq_pk2_3bc} {#PerAuth-isTokenValid_S__table_opq_pk2_3bc__entry__2}

| Tipo | Descrição |
|-|-|
| Booliano | Sinalizador que indica se há uma credencial de autorização pessoal associada para o ID do alias especificado. Valores válidos: * verdadeiro: existe uma credencial de autorização pessoal válida. * falso: não existe uma credencial de autorização pessoal válida. |
[Tabela 5. Retorna]

{#PerAuth-isTokenValid_S__table_opq_pk2_3bc}  
O exemplo de código a seguir mostra como chamar este método.

    var aliasId = "e41b9dd1532102104c4bddeeff7b1250"; 
    var personalAuthAPI = new sn_cc.PersonalAuthAPI();  
    var result = personalAuthAPI.isTokenValid(aliasId); 
    gs.info(result);

Saída:

    true

## PersonalAuthAPI - revokeToken(cadeia de caracteres aliasId) {#ariaid-title5}

Revoga um token de acesso/atualização existente para a credencial de autenticação pessoal associada a um alias especificado.
{#PerAuth-revokeToken_S__table_nsn_nwk_3bc__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| aliasId | Cadeia de caracteres | Sys_id do alias de conexão ou credencial cujo token de acesso/atualização da credencial de autorização pessoal você deseja revogar. Localizado na tabela Aliases de conexão e credencial \[sys_alias\]. |
[Tabela 6. Parâmetros]

{#PerAuth-revokeToken_S__table_nsn_nwk_3bc} {#PerAuth-revokeToken_S__table_osn_nwk_3bc__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Objeto que contém métodos que você pode chamar para obter informações adicionais sobre o status da credencial e da chamada de método. Esses métodos estão disponíveis até a próxima vez que este método for chamado. * \<object_name.getResponseStatus(): retorna o status da chamada do método revokeToken(), sucesso ou falha. Você pode encontrar informações adicionais sobre qualquer erro nos logs de erro. * \<object_name.getExpiryInSeconds(): retorna o número de segundos até que a credencial associada expire. Se este valor for diferente de zero, a solicitação de revogação falhou. * \<object_name.isAuthenticated(): retorna um valor booliano que indica se o token de autenticação pessoal existe. Se a chamada do método revokeToken() tiver sido bem-sucedida, este método deverá retornar falso. * \<object_name.getCredentialId(): retorna o sys_id da credencial de autorização pessoal associada ao token. Localizado na tabela Credenciais do OAuth 2.0 \[oauth_2_0_credentials\]. |
[Tabela 7. Retorna]

{#PerAuth-revokeToken_S__table_osn_nwk_3bc}  
O exemplo de código a seguir mostra como chamar este método.

    var aliasId = "e41b9dd1532102104c4bddeeff7b1250";
    var personalAuthAPI = new sn_cc.PersonalAuthAPI();
    var personalAuthResponse = personalAuthAPI.revokeToken(aliasId); 
    gs.info(personalAuthResponse.getResponseStatus());
    gs.info(personalAuthResponse.getExpiryInSeconds());
    gs.info(personalAuthResponse.isAuthenticated());
    gs.info(personalAuthResponse.getCredentialId());

Saída:

    SUCCESS
    0
    false
    d84b5115532102104c4bddeeff7b12f2