PersonalAuthAPI – Umfang

Die PersonalAuthAPI Stellt Methoden bereit, mit denen Sie Zugriffs-/Aktualisierungstoken für Anmeldeinformationen zur persönlichen Authentifizierung verwalten können.

Um auf diese API zuzugreifen, muss das Plugin „persönliche Authentifizierung“ (com.snc.sn_ihub_Personal_auth) aktiviert sein. Diese API wird in ausgeführt sn_cc Namespace.

Vor dem Zugriff auf diese API muss die persönliche Authentifizierung in Ihrer Instanz konfiguriert werden. Weitere Informationen finden Sie unter Create a Connection & Credential alias.

PersonalAuthAPI: PersonalAuthAPI()

Instanziiert ein neues PersonalAuthAPI-Objekt.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
Keine

Das folgende Codebeispiel zeigt, wie ein PersonalAuthAPI-Objekt instanziiert wird.

var personalAuthAPI = new sn_cc.PersonalAuthAPI();

PersonalAuthAPI – getInitiatorURL(Zeichenfolge aliasId)

Gibt die OAuth-Initiator-URL für die Anmeldeinformationen für die persönliche Authentifizierung zurück, die einem angegebenen Alias zugeordnet sind.

Tabelle : 2. Parameter

Name	Typ	Beschreibung
aliasId	Zeichenfolge	SYS_ID des Verbindungs- oder Anmeldeinformationsalias, dessen OAuth-Initiator-URL Sie abrufen möchten. Tabelle: Aliasse für Verbindungen und Anmeldeinformationen [sys_alias]

Tabelle : 3. Rückgaben

Typ	Beschreibung
Zeichenfolge	OAuth-Initiator-URL für die Anmeldeinformationen für die persönliche Authentifizierung, die dem angegebenen Alias zugeordnet sind. Wenn die Anmeldeinformationen für die persönliche Authentifizierung für den angegebenen Alias nicht vorhanden sind, gibt die Methode eine leere Zeichenfolge zurück.

Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

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

Ausgabe:

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

PersonalAuthAPI – isTokenValid(Zeichenfolge aliasId)

Überprüft, ob ein gültiges Zugriffs-/Aktualisierungstoken für die Anmeldeinformationen für die persönliche Autorisierung vorhanden ist, die einem angegebenen Alias zugeordnet sind.

Tabelle : 4. Parameter

Name	Typ	Beschreibung
aliasId	Zeichenfolge	SYS_ID des Verbindungs- oder Anmeldeinformationsalias, um nach den zugehörigen persönlichen Autorisierungsanmeldeinformationen zu suchen. Tabelle: Aliasse für Verbindungen und Anmeldeinformationen [sys_alias]

Tabelle : 5. Rückgaben

Typ	Beschreibung
Boolean	Kennzeichnung, die angibt, ob für die angegebene Alias-ID zugeordnete persönliche Autorisierungsanmeldeinformationen vorhanden sind. Mögliche Werte: Wahr: Es sind gültige Anmeldeinformationen für die persönliche Autorisierung vorhanden. Falsch: Es sind keine gültigen Anmeldeinformationen für die persönliche Autorisierung vorhanden.

Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

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

Ausgabe:

true

PersonalAuthAPI – revokeToken(Zeichenfolge aliasId)

Widerruft ein vorhandenes Zugriffs-/Aktualisierungstoken für die Anmeldeinformationen für die persönliche Authentifizierung, die einem angegebenen Alias zugeordnet sind.

Tabelle : 6. Parameter

Name	Typ	Beschreibung
aliasId	Zeichenfolge	SYS_ID des Verbindungs- oder Anmeldeinformationsalias, dessen Zugriffs-/Aktualisierungstoken für die persönlichen Autorisierungsanmeldeinformationen Sie widerrufen möchten. Tabelle: Aliasse für Verbindungen und Anmeldeinformationen [sys_alias]

Tabelle : 7. Rückgaben

Typ

Beschreibung

Objekt

Objekt, das Methoden enthält, die Sie aufrufen können, um zusätzliche Informationen zum Status der Anmeldeinformationen und des Methodenaufrufs zu erhalten. Diese Methoden sind bis zum nächsten Aufruf dieser Methode verfügbar. <object_name>.getResponseStatus() : Gibt den Status von zurück RevokeToken() Methodenaufruf Erfolg Oder Fehlgeschlagen . Zusätzliche Informationen zu Fehlern finden Sie in den Fehlerprotokollen. <object_name>.getExpiryInSeconds(): Gibt die Anzahl der Sekunden zurück, bis die zugehörigen Anmeldeinformationen ablaufen. Wenn dieser Wert etwas anderes als null ist, ist die Widerrufsanforderung fehlgeschlagen. <object_name>.isAuthenticated() : Gibt einen booleschen Wert zurück, der angibt, ob das persönliche Authentifizierungstoken vorhanden ist. Wenn RevokeToken() Methodenaufruf war erfolgreich, diese Methode muss zurückgeben Falsch . <object_name>.getCredentialId() : Gibt die sys_ID der persönlichen Autorisierungsanmeldeinformationen zurück, die dem Token zugeordnet sind. Befindet sich in der Tabelle „OAuth 2,0-Anmeldeinformationen“ [oauth_2_0_credentials].

Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

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

Ausgabe:

SUCCESS
0
false
d84b5115532102104c4bddeeff7b12f2