PersonalAuthAPI : Bereichsbezogen

Die PersonalAuthAPI stellt Methoden bereit, mit denen Sie Zugriffs-/Aktualisierungstoken für Anmeldeinformationen für die persönliche Authentifizierung verwalten können.

Für den Zugriff auf diese API muss das Plugin „Personal Authentication“ (com.snc.sn_ihub_personal_auth) aktiviert sein. Diese API wird im Namespace sn_cc ausgeführt.

Bevor Sie auf diese API zugreifen, 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(String aliasId)

Gibt die OAuth-Initiator-URL für die persönlichen Authentifizierungsanmeldeinformationen 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 persönlichen Authentifizierungsanmeldeinformationen, die dem angegebenen Alias zugeordnet sind. Wenn für den angegebenen Alias keine persönlichen Authentifizierungsanmeldeinformationen 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(String aliasId)

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

Tabelle : 4. Parameter

Name	Typ	Beschreibung
aliasId	Zeichenfolge	Sys_id des Verbindungs- oder Anmeldeinformationsalias, um nach den zugeordneten Anmeldeinformationen für die persönliche Autorisierung 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 Anmeldeinformationen für die persönliche Autorisierung 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 – refokeToken(String aliasId)

Widerruft ein vorhandenes Zugriffs-/Aktualisierungstoken für die persönlichen Authentifizierungsanmeldeinformationen, 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 Anmeldeinformationen für die persönliche Autorisierung 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 über den 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 des Aufrufs der refokeToken()- Methode zurück, entweder Erfolg oder Fehler. Zusätzliche Informationen zu jedem Fehler finden Sie in den Fehlerprotokollen. <object_name.getExpiryInSeconds(): Gibt die Anzahl der Sekunden zurück, bis die zugeordneten 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 der Aufruf der Methode „revokeToken()“ erfolgreich war, sollte diese Methode „false“zurückgeben. <object_name.getCredentialId(): Gibt die sys_id der Anmeldeinformationen für die persönliche Autorisierung zurück, die dem Token zugeordnet sind. Befindet sich in der Tabelle mit den 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