PersonalAuthAPI - com escopo

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.

PersonalAuthAPI - PersonalAuthAPI()

Instancia um novo objeto PersonalAuthAPI.

Tabela 1. Parâmetros

Nome	Tipo	Descrição
Nenhum(a)

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)

Retorna o URL do iniciador do OAuth para a credencial de autenticação pessoal associada a um alias especificado.

Tabela 2. Parâmetros

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 3. Retorna

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.

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)

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

Tabela 4. Parâmetros

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 5. Retorna

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.

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)

Revoga um token de acesso/atualização existente para a credencial de autenticação pessoal associada a um alias especificado.

Tabela 6. Parâmetros

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

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

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