PersonalAuthAPI - 범위 지정됨

PersonalAuthAPI는 개인 인증 자격 증명에 대한 액세스/새로 고침 토큰을 관리할 수 있는 메서드를 제공합니다.

이 API에 액세스하려면 com.snc.sn_ihub_personal_auth(개인 인증) 플러그인을 활성화해야 합니다. 이 API는 sn_cc 네임스페이스에서 실행됩니다.

이 API에 액세스하기 전에 인스턴스에 개인 인증을 구성해야 합니다. 자세한 내용은 Create a Connection & Credential alias 문서를 참조하십시오.

개인 AuthAPI - PersonalAuthAPI()

새 PersonalAuthAPI 개체를 인스턴스화합니다.

표 1. 매개변수

이름	유형	설명
안 함

다음 코드 예제에서는 PersonalAuthAPI 개체를 인스턴스화하는 방법을 보여 줍니다.

var personalAuthAPI = new sn_cc.PersonalAuthAPI();

PersonalAuthAPI - getInitiatorURL(문자열 aliasId)

지정된 별명과 연관된 개인 인증 자격 증명에 대한 OAuth 개시자 URL을 반환합니다.

표 2. 매개변수

이름	유형	설명
aliasId	문자열	검색할 OAuth 개시자 URL의 연결 또는 자격 증명 별칭 Sys_id입니다. 테이블: 연결 및 자격 증명 별칭 [sys_alias]

표 3. 반환

유형	설명
문자열	지정된 별칭과 연결된 개인 인증 자격 증명에 대한 OAuth 개시자 URL입니다. 지정된 별칭에 대한 개인 인증 자격 증명이 없는 경우 메서드는 빈 문자열을 반환합니다.

다음 코드 예제에서는 이 메서드를 호출하는 방법을 보여 줍니다.

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

출력:

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

PersonalAuthAPI - isTokenValid(문자열 aliasId)

지정된 별칭과 연결된 개인 권한 부여 자격 증명에 유효한 접근/새로 고침 토큰이 있는지 확인합니다.

표 4. 매개변수

이름	유형	설명
aliasId	문자열	연결된 개인 권한 부여 자격 증명을 확인하기 위한 연결 또는 자격 증명 별칭의 Sys_id입니다. 테이블: 연결 및 자격 증명 별칭 [sys_alias]

표 5. 반환

유형	설명
부울	지정된 별칭 ID에 대한 연결된 개인 인증 자격 증명이 있는지 여부를 나타내는 플래그입니다. 가능한 값: true: 유효한 개인 인증 자격 증명이 있습니다. false: 유효한 개인 인증 자격 증명이 없습니다.

다음 코드 예제에서는 이 메서드를 호출하는 방법을 보여 줍니다.

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

출력:

true

PersonalAuthAPI - revokeToken(문자열 aliasId)

지정된 별칭과 연결된 개인 인증 자격 증명에 대한 기존 접근/새로 고침 토큰을 취소합니다.

표 6. 매개변수

이름	유형	설명
aliasId	문자열	해지하려는 개인 인증 자격 증명에 대한 접근/새로 고침 토큰이 포함된 연결 또는 자격 증명 별칭의 Sys_id입니다. 테이블: 연결 및 자격 증명 별칭 [sys_alias]

표 7. 반환

유형

설명

객체

자격 증명 및 메서드 호출 상태에 대한 추가 정보를 얻기 위해 호출할 수 있는 메서드가 포함된 객체입니다. 이러한 메서드는 다음에 이 메서드를 호출할 때까지 사용할 수 있습니다. <object_name>.getResponseStatus():revokeToken() 메서드 호출의 상태(성공 또는 실패)를 반환합니다. 오류 로그에서 오류에 대한 추가 정보를 찾을 수 있습니다. <object_name>.getExpiryInSeconds(): 연결된 자격 증명이 만료될 때까지의 시간(초)을 반환합니다. 이 값이 0이 아니면 해지 요청에 실패한 것입니다. <object_name>.isAuthenticated(): 개인 인증 토큰이 있는지 여부를 나타내는 부울 값을 반환합니다. revokeToken() 메서드 호출이 성공한 경우 이 메서드는 false를 반환해야 합니다. <object_name>.getCredentialId(): 토큰과 연결된 개인 인증 자격 증명의 sys_id 반환합니다. OAuth 2.0 자격 증명 [oauth_2_0_credentials] 테이블에 있습니다.

다음 코드 예제에서는 이 메서드를 호출하는 방법을 보여 줍니다.

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());

출력:

SUCCESS
0
false
d84b5115532102104c4bddeeff7b12f2