---
sourceDocument: Xanadu-API-Referenz
sourceDocumentLink: https://www.servicenow.com/docs/r/de-DE/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - de-DE

ft:publication_title :

    - Xanadu-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# PersonalAuthAPI : Bereichsbezogen

# PersonalAuthAPI : Bereichsbezogen {#ariaid-title1}

* Freigeben Version: Xanadu
* 
* Aktualisiert 1. August 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 Minuten Lesedauer

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](https://www.servicenow.com/docs/access?context=connection-alias&version=xanadu&pubname=xanadu-platform-security&ft:locale=en-US).

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

Instanziiert ein neues PersonalAuthAPI-Objekt.
{#PerAuth-PersonalAuthAPI__table_t5w_235_lbc__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 1. Parameter]

{#PerAuth-PersonalAuthAPI__table_t5w_235_lbc}  
Das folgende Codebeispiel zeigt, wie ein PersonalAuthAPI-Objekt instanziiert wird.

    var personalAuthAPI = new sn_cc.PersonalAuthAPI();

## PersonalAuthAPI -- getInitiatorURL(String aliasId) {#ariaid-title3}

Gibt die OAuth-Initiator-URL für die persönlichen Authentifizierungsanmeldeinformationen zurück, die einem angegebenen Alias zugeordnet sind.
{#PerAuth-getInitiatorURL_S__table_fhk_4bl_3bc__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| aliasId | Zeichenfolge | Sys_id des Verbindungs- oder Anmeldeinformationsalias, dessen OAuth-Initiator-URL Sie abrufen möchten. Befindet sich in der Tabelle „Aliasse für Verbindungen und Anmeldeinformationen" \[sys_alias\]. |
[Tabelle : 2. Parameter]

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

| 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. |
[Tabelle : 3. Ergebnisse]

{#PerAuth-getInitiatorURL_S__table_ghk_4bl_3bc}  
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) {#ariaid-title4}

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

| Name | Typ | Beschreibung |
|-|-|-|
| aliasId | Zeichenfolge | Sys_id des Verbindungs- oder Anmeldeinformationsalias, um nach den zugeordneten Anmeldeinformationen für die persönliche Autorisierung zu suchen. Befindet sich in der Tabelle „Aliasse für Verbindungen und Anmeldeinformationen" \[sys_alias\]. |
[Tabelle : 4. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Boolean | Kennzeichnung, die angibt, ob für die angegebene Alias-ID Anmeldeinformationen für die persönliche Autorisierung vorhanden sind. Gültige 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. |
[Tabelle : 5. Ergebnisse]

{#PerAuth-isTokenValid_S__table_opq_pk2_3bc}  
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) {#ariaid-title5}

Widerruft ein vorhandenes Zugriffs-/Aktualisierungstoken für die persönlichen Authentifizierungsanmeldeinformationen, die einem angegebenen Alias zugeordnet sind.
{#PerAuth-revokeToken_S__table_nsn_nwk_3bc__entry__3}

| 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. Befindet sich in der Tabelle „Aliasse für Verbindungen und Anmeldeinformationen" \[sys_alias\]. |
[Tabelle : 6. Parameter]

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

| 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\]. |
[Tabelle : 7. Ergebnisse]

{#PerAuth-revokeToken_S__table_osn_nwk_3bc}  
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


